CLI reference
Complete reference for all AlignTrue CLI commands organized by user workflow.
aln is a shorthand alias for every command (e.g., aln sync).
Getting started
New to AlignTrue? Start here:
- Init - Set up your project (
aligntrue init) - Sync - Export rules to agents (
aligntrue sync) - Check - Validate your rules (
aligntrue check)
Command categories
Browse commands by category:
- Core commands - Essential daily workflow (init, sync, check, status, doctor)
- Sources - Manage rule imports and git sources (add, add source, add remote, remove, sources)
- Exporters - Manage agents (list, enable, disable, detect, ignore)
- Plugs - Stack-agnostic variable management (list, resolve, set)
- Overlays - Customize rules without forking (add, status, diff, remove)
- Team mode - Collaboration and governance (drift, onboard, team, scopes, team join)
- Backups - Backup and recovery (create, list, restore, cleanup, revert)
- Settings - Configuration and privacy (config, privacy)
- Migration - Schema migration and imports (migrate)
All commands quick reference
| Command | Description | Category |
|---|---|---|
aligntrue init | Initialize project with agent detection | Core |
aligntrue sync | Sync rules to agents | Core |
aligntrue check | Validate rules | Core |
aligntrue status | Show current status and exporters | Core |
aligntrue doctor | Run health checks and verification | Core |
aligntrue add | One-time import from git URL or local path | Sources |
aligntrue add source | Keep a git source connected for updates | Sources |
aligntrue add remote | Add a push destination for rules | Sources |
aligntrue remove | Remove a source | Sources |
aligntrue sources | Manage rule sources | Sources |
aligntrue exporters | Manage exporters | Exporters |
aligntrue plugs list | 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 onboard | Developer onboarding | Team |
aligntrue team enable | Enable team mode | Team |
aligntrue team join | Create personal config in team repo | Team |
aligntrue scopes | List scopes | Team |
aligntrue backup | Backup management | Backups |
aligntrue revert | Restore files from backup | Backups |
aligntrue config | View or edit configuration | Settings |
aligntrue privacy | Privacy consents | Settings |
aligntrue migrate | Schema migration | Migration |
Quick examples
Initialize a new project:
aligntrue initSync rules to all configured agents:
aligntrue syncCheck 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