Skip to Content
04 ReferenceCLI ReferenceOverview

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: import command or sync --accept-agent

Quick reference:

  • Author in .md files → use md commands
  • Work with generated .md files → use import or sync
  • Both formats are valid - they serve different purposes!

Command categories

Browse commands by category:


All commands

Quick lookup table for all CLI commands:

CommandDescriptionCategory
aligntrue initInitialize project with agent detectionBasic
aligntrue importImport from agent formatsBasic
aligntrue syncSync rules to agentsBasic
aligntrue checkValidate rulesBasic
aligntrue backupBackup managementBasic
aligntrue adaptersManage exportersDevelopment
aligntrue md lintLint markdownDevelopment
aligntrue md formatFormat markdownDevelopment
aligntrue md compileCompile to IRDevelopment
aligntrue md generateGenerate markdownDevelopment
aligntrue plugs auditList 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 updateApply updatesTeam
aligntrue onboardDeveloper onboardingTeam
aligntrue team enableEnable team modeTeam
aligntrue scopesList scopesTeam
aligntrue pullPull from gitTeam
aligntrue linkVendor packsTeam
aligntrue configView or edit configurationSettings
aligntrue migrateSchema migration (pre-1.0)Settings
aligntrue teamTeam mode managementSettings
aligntrue telemetryTelemetry controlSettings
aligntrue privacyPrivacy consentsSettings

Quick examples

Initialize a new project:

aligntrue init

Sync rules to all configured agents:

aligntrue sync

Import existing Cursor rules:

aligntrue import --from cursor

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