@bitforgehq/ai-instructions

AI coding instruction files and CLI tool for syncing standards to consumer projects.

Installation

bun add -D @bitforgehq/ai-instructions

Usage

CLI Tool

The package provides a standards CLI command for syncing instruction files to your project.

Web Projects

bunx standards sync-ai --type web

This creates a .ai/ folder in your project root with:

• INSTRUCTIONS.md - Global engineering principles and all guidelines

Ionic Projects

bunx standards sync-ai --type ionic

This creates a .ai/ folder in your project root with:

• INSTRUCTIONS.md - Global engineering principles and all guidelines

Package.json Script

Add to your package.json:

{
  "scripts": {
    "standards:sync": "standards sync-ai --type web"
  }
}

For Ionic projects:

{
  "scripts": {
    "standards:sync": "standards sync-ai --type ionic"
  }
}

Then run:

bun run standards:sync

Instruction Files

INSTRUCTIONS.md

Comprehensive engineering principles and guidelines including:

• Core principles (don't fight linter/formatter, standalone components, type safety)
• Code style preferences
• Architecture preferences
• File organization
• Naming conventions
• Error handling
• Documentation
• Angular-specific guidance
• Ionic-specific guidance (when using --type ionic)

Output Location

The CLI creates a .ai/ folder in your project root (where you run the command). The folder contains the relevant instruction markdown files.

Updating Instructions

To update the instructions in your project, simply run the sync command again. It will overwrite existing files in the .ai/ folder.

Integration with AI Tools

These instruction files are designed to be used with AI coding assistants (like Cursor, GitHub Copilot, etc.). Place them in a location where your AI tool can reference them, or copy them to your project's documentation.

Examples

See examples/consumer-web/ and examples/consumer-ionic/ for complete setup examples.