Skip to content

CLI reference

Run any command with npx @align-agent/cli or, after align init, as align. This page is generated from the CLI's own command definitions; every command also prints this with --help.

Usage: align [options] [command]

Options:
  -v, --version                 output the version number
  -h, --help                    display help for command

Commands:
  init [options]                connect this repository: sign in, claim it and
                                opt in
  login [options]               sign in with a device code
  logout [options]              sign out and revoke the token
  status [options]              what is captured here, and where it goes
  doctor [options]              check the installation, with a fix line for each
                                failure
  confirm [options] [keys...]   review the proposals from your sessions:
                                confirm, reject, edit or share each
  decide [options] <statement>  record a decision you made (confirmed; you are
                                its author)
  sessions [action] [id]        what was kept from your sessions here; delete
                                one with rm
  export [options]              export this repository's ledger (Markdown or
                                JSON)
  ask [options] <question>      open a question for the repository
  verify [options]              run this repository's checks on your working
                                tree; only paths and line numbers are sent
  backfill [options]            read your recent agent sessions here again and
                                find decisions you already made
  pack [options]                print the team decisions that apply here (the
                                pack your agent gets)
  mcp [options]                 run the MCP server on stdio (your agent starts
                                it; init registers it)
  on                            opt this repository in
  off                           opt this repository out; capture stops
                                immediately
  uninstall [options]           remove what was added for this repository
  help [command]                display help for command

align init

Connect this repository: sign in, claim it and opt in.

align init [options]
Options of init
OptionWhat it does
--harness <list>harnesses to configure (claude-code,cursor,codex)
-y, --yesaccept the defaults without asking
--no-backfillskip reading recent sessions
--days <n>how many days of history to read
--server <url>the server to use
--org <slug>the organisation to use
--remote <name>the git remote that identifies this repository
--accept-pilot-termsaccept a beta organisation's pilot data terms (with --yes)

align login

Sign in with a device code.

align login [options]
Options of login
OptionWhat it does
--org <slug>the organisation to sign in to
--server <url>the server to use

align logout

Sign out and revoke the token.

align logout [options]
Options of logout
OptionWhat it does
--allevery organisation

align status

What is captured here, and where it goes.

align status [options]
Options of status
OptionWhat it does
--jsonmachine-readable output

align doctor

Check the installation, with a fix line for each failure.

align doctor [options]
Options of doctor
OptionWhat it does
--jsonmachine-readable output
--benchtime 200 synthetic hook runs per event (p50 and p95)

align confirm

Review the proposals from your sessions: confirm, reject, edit or share each.

align confirm [options] [keys...]
  • [keys]: confirm these proposals without the interactive view
Options of confirm
OptionWhat it does
--listprint the waiting proposals
--reject <reason>reject the given keys with this reason instead

align decide

Record a decision you made (confirmed; you are its author).

align decide [options] <statement>
  • <statement>: the decision, 12 to 280 characters
Options of decide
OptionWhat it does
--why <text>the reason
--rejected <alternative>an alternative you rejected (repeatable)
--paths <list>repository paths it applies to, comma-separated
--commitmenta commitment rather than a decision
--owner <email>who owns the commitment
--due <date>when the commitment is due (YYYY-MM-DD)

align sessions

What was kept from your sessions here; delete one with rm.

align sessions [options] [action] [id]
  • [action]: list, show or rm
  • [id]: the session id (show, rm)

align export

Export this repository's ledger (Markdown or JSON).

align export [options]
Options of export
OptionWhat it does
--format <format>md or json (default: md)
--layout <layout>single or adr (default: single)
--out <dir>write the files into this directory
--include-privatealso your own proposals nobody else sees yet
--forcereplace files in --out that are not an earlier export

align ask

Open a question for the repository.

align ask [options] <question>
  • <question>: the question, 12 to 280 characters
Options of ask
OptionWhat it does
--owner <email>who should answer it

align verify

Run this repository's checks on your working tree; only paths and line numbers are sent.

align verify [options]
Options of verify
OptionWhat it does
--jsonprint the results as JSON

align backfill

Read your recent agent sessions here again and find decisions you already made.

align backfill [options]
Options of backfill
OptionWhat it does
--days <n>how many days of history to read
--harness <list>only these harnesses (claude-code,cursor,codex)
-y, --yesread and upload without asking

align pack

Print the team decisions that apply here (the pack your agent gets).

align pack [options]
Options of pack
OptionWhat it does
--format <format>md or json (default: md)
--paths <paths...>ask for these repository paths instead of the ones you are working on

align mcp

Run the MCP server on stdio (your agent starts it; init registers it).

align mcp [options]
Options of mcp
OptionWhat it does
--cwd <dir>the repository to answer for
--print-config <agent>print the snippet for gemini, hermes, openclaw or generic

align on

Opt this repository in.

align on [options]

align off

Opt this repository out; capture stops immediately.

align off [options]

align uninstall

Remove what was added for this repository.

align uninstall [options]
Options of uninstall
OptionWhat it does
--purgealso delete everything kept on this laptop
-y, --yesdo not ask

align flush

Not in --help: the hooks run the uploader for you. align flush sends the events waiting on this laptop now and prints why any are held back or refused; align doctor suggests it when the spool does not drain.