Overview
Complete reference for all AlignTrue CLI commands.
Important: Markdown format distinction
Literate markdown (for authoring):
- Use fenced ```aligntrue blocks
- Commands:
md lint,md compile,md format,md generate - Files you create manually
- See Markdown authoring guide
Generated exports (created by AlignTrue):
- Use HTML comment markers (
<!-- aligntrue:begin -->) - Generated by:
sync,import, exporters - Files AlignTrue creates automatically
- Edit with:
importcommand orsync --accept-agent
Quick reference:
- Author in
.mdfiles → usemdcommands - Work with generated
.mdfiles → useimportorsync - Both formats are valid - they serve different purposes!
Command categories
Browse commands by category:
- Basic commands - Daily development (init, import, sync, check, backup)
- Development commands - Markdown authoring and adapter management
- Plugs commands - Stack-agnostic variable management
- Overlay commands - Selective rule modifications
- Team mode commands - Collaboration and drift detection
- Settings commands - Configuration and privacy
All commands
Quick lookup table for all CLI commands:
| Command | Description | Category |
|---|---|---|
aligntrue init | Initialize project with agent detection | Basic |
aligntrue import | Import from agent formats | Basic |
aligntrue sync | Sync rules to agents | Basic |
aligntrue check | Validate rules | Basic |
aligntrue backup | Backup management | Basic |
aligntrue adapters | Manage exporters | Development |
aligntrue md lint | Lint markdown | Development |
aligntrue md format | Format markdown | Development |
aligntrue md compile | Compile to IR | Development |
aligntrue md generate | Generate markdown | Development |
aligntrue plugs audit | List slots and fills | Plugs |
aligntrue plugs resolve | Preview resolution | Plugs |
aligntrue plugs set | Set fill value | Plugs |
aligntrue override add | Create overlay | Overlays |
aligntrue override status | View overlays | Overlays |
aligntrue override diff | Show overlay effects | Overlays |
aligntrue override remove | Remove overlay | Overlays |
aligntrue drift | Detect drift | Team |
aligntrue update | Apply updates | Team |
aligntrue onboard | Developer onboarding | Team |
aligntrue team enable | Enable team mode | Team |
aligntrue scopes | List scopes | Team |
aligntrue pull | Pull from git | Team |
aligntrue link | Vendor packs | Team |
aligntrue config | View or edit configuration | Settings |
aligntrue migrate | Schema migration (pre-1.0) | Settings |
aligntrue team | Team mode management | Settings |
aligntrue telemetry | Telemetry control | Settings |
aligntrue privacy | Privacy consents | Settings |
Quick examples
Initialize a new project:
aligntrue initSync rules to all configured agents:
aligntrue syncImport existing Cursor rules:
aligntrue import --from cursorCheck rules for errors:
aligntrue checkEnable team mode:
aligntrue team enableFor detailed documentation on each command, browse the categories above or use the command table to jump directly to specific commands.
Last updated on