ADMIRAL Knowledge base Request invite
Docs / ReferenceView markdown

Command line

The admiral command controls the engine from a terminal. The app and the CLI share one engine and one data directory.

Commands

CommandWhat it does
admiral loginSign in to your account.
admiral logoutSign out.
admiral statusShow the engine and account state.
admiral updateUpdate Admiral to the latest release.
admiral headlessRun the engine with no window.
admiral daemon installInstall the engine as a user service that starts at login.
admiral daemon startStart the service.
admiral daemon stopStop the service.
admiral daemon restartRestart the service.
admiral daemon statusShow the service state.
admiral daemon uninstallRemove the service.
admiral chatDrive sessions from scripts, with JSON output and typed exit codes.

Rules

The data directory

Admiral keeps its data, including sessions, under your home directory in ~/.admiral. Delete nothing there while the engine runs.

Next steps