Skip to Content
ReferenceCLI ReferenceCLI reference

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:

  1. Init - Set up your project (aligntrue init)
  2. Sync - Export rules to agents (aligntrue sync)
  3. 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

CommandDescriptionCategory
aligntrue initInitialize project with agent detectionCore
aligntrue syncSync rules to agentsCore
aligntrue checkValidate rulesCore
aligntrue statusShow current status and exportersCore
aligntrue doctorRun health checks and verificationCore
aligntrue addOne-time import from git URL or local pathSources
aligntrue add sourceKeep a git source connected for updatesSources
aligntrue add remoteAdd a push destination for rulesSources
aligntrue removeRemove a sourceSources
aligntrue sourcesManage rule sourcesSources
aligntrue exportersManage exportersExporters
aligntrue plugs listList slots and fillsPlugs
aligntrue plugs resolvePreview resolutionPlugs
aligntrue plugs setSet fill valuePlugs
aligntrue override addCreate overlayOverlays
aligntrue override statusView overlaysOverlays
aligntrue override diffShow overlay effectsOverlays
aligntrue override removeRemove overlayOverlays
aligntrue driftDetect driftTeam
aligntrue onboardDeveloper onboardingTeam
aligntrue team enableEnable team modeTeam
aligntrue team joinCreate personal config in team repoTeam
aligntrue scopesList scopesTeam
aligntrue backupBackup managementBackups
aligntrue revertRestore files from backupBackups
aligntrue configView or edit configurationSettings
aligntrue privacyPrivacy consentsSettings
aligntrue migrateSchema migrationMigration

Quick examples

Initialize a new project:

aligntrue init

Sync rules to all configured agents:

aligntrue sync

Check rules for errors:

aligntrue check

Enable team mode:

aligntrue team enable

For detailed documentation on each command, browse the categories above or use the command table to jump directly to specific commands.

Last updated on