Aura Docs

CLI Reference

Every aura command with usage and flags, grouped by topic.

The aura CLI is the entry point for everything you can drive from a terminal: lifecycle, capabilities, services, content providers, the event bus, sandbox shells. Source: packages/aura-cli/src/commands/.

Run any command with --help for context-sensitive usage.

Aliases at a glance

ShortLong
aura lsaura app list
aura psaura inst list (running only)
aura jaura jump
aura inst lsaura inst list
aura app rmaura app remove
aura cap lsaura cap list
aura activity lsaura activity list

App store & distribution — aura nexus …

Publish, install, update apps and manage registries. Commands are grouped into app, registry, and search; every one posts to the shell's /api/nexus/* endpoints, so the CLI and the Nexus app share one backend. See Nexus for the model and Publish an App for a walkthrough. (The old flat spellings — aura nexus install, aura nexus publish, aura nexus registries … — still work as hidden aliases.)

Apps — aura nexus app …

CommandDescriptionKey flags
aura nexus app publish [<path>]Push the app to a registry (OCI) or git repo. Bare + interactive = wizard.--to <name|url|repo>, --kind oci|git, --tag, --channel, --branch, -y
aura nexus app install <ref>Resolve + fetch + validate + install. Pauses on new-permission diffs unless -y.-y, --channel <name>, --scope global|user
aura nexus app update [<id>|--all]Re-resolve the stored ref and reinstall if changed.-y, --all
aura nexus app uninstall <id>Kill all instances + remove from disk. --purge also wipes /data/<id>.--purge
aura nexus app listInstalled apps with id, version, scope, source, ref.--source git|oci|index|local
aura nexus app info <ref>Dry-run resolve — resolved address + permission preview, no install.

Registries / sources — aura nexus registry …

CommandDescriptionKey flags
aura nexus registry add <name> <url>Register a source. Kind is required.--kind oci|git-index|git-app, --priority <n>, --mirror, --ref <git-ref>
aura nexus registry listEvery source: name, kind, url, priority, flags.
aura nexus registry remove <name>Drop a source (refuses the last OCI registry).

Search

CommandDescriptionKey flags
aura nexus search [<q>]Search the aggregated catalog by id / name / description / tag.--category <slug>, --refresh

Ref shapes aura nexus app install / info accept (dispatched on shape):

ShapeExample
Store idcom.example.foo, com.example.foo@beta
OCIoci://ghcr.io/u/foo:1.2.3, ghcr.io/u/foo@sha256:…
Git URL with optional refhttps://github.com/u/r#main, github.com/u/r#v1.2.3
Local path./apps/com.example.foo, /abs/path

App management — aura app …

CommandDescriptionKey flags
aura app listAll installed apps (ID, NAME, VERSION, INSTANCES, MODE, BG, EN).
aura app info <appId>Full manifest + instances + activities (JSON).
aura app start <appId>Spawn a new instance; returns its instanceId.
aura app stop <appId>Stop ALL instances of the app gracefully.
aura app restart <appId>stop then start one fresh instance.
aura app install <path>Install app from a local directory (must contain app.manifest.json).
aura app remove <appId>Stop all instances + delete from disk.-y, --yes skip confirm
aura app enable <appId>Re-arm autoStart/warmPool; unhide from dock + launcher.
aura app disable <appId>Stop all instances + hide from dock/launcher.

Instance management — aura inst …

CommandDescriptionKey flags
aura inst listRunning instances (INSTANCE, APP, STATE, PORT, PID, UPTIME).-a, --app <appId> filter
aura inst info <instanceId>Full status (manifest, state, activities) JSON.
aura inst stop <instanceId>Graceful stop: onPauseonStoponDestroy then kill sandbox.
aura inst kill <instanceId>SIGKILL the sandbox immediately. No hooks.
aura inst pause <instanceId>Fire onPause only.
aura inst resume <instanceId>Fire onResume on a paused instance.
aura inst shell <instanceId>Drop into an interactive shell inside the sandbox.-c, --cmd "<cmd>"
aura inst logs <instanceId>Tail recent log output.-f, --follow

Activity management — aura activity …

CommandDescriptionKey flags
aura activity listAll activities (ACTIVITY, INSTANCE, APP, PATH, TITLE).-i, --instance <id> filter
aura activity open <instanceId>Open a new activity on a running instance.-d, --data '<json>' payload
aura activity close <activityId>Close one activity. The instance stops too if it was the last activity and the app isn't backgroundService.

Capabilities — aura cap …

Allowlist-based binary access. cap install adds a tool to the OS- wide toolchain (/aura/all-tools); cap grant exposes it to a specific app's sandbox (/aura/my-tools).

CommandDescriptionKey flags
aura cap listRegistry inventory (NAME, SOURCE, INSTALLED, DECLARED-BY).--installed, --available
aura cap info <name>Registry entry + install status + apps declaring it.
aura cap install <name…>Install one+ capabilities (apt/npm/curl per registry).
aura cap remove <name>Uninstall + remove from every app manifest.
aura cap grant <appId> <name…>Add to app's tools[]; hot-refresh running instances. Use '*' to grant all.
aura cap revoke <appId> <name…>Remove from app's tools[]; restart running instances.
aura cap registry showPrint the capability registry (JSON).
aura cap registry add <name>Add a new capability to the registry.--source <type> --package <pkg> --binary <bin> --url <url>
aura cap registry remove <name>Remove a capability definition.

Services — aura service …

Long-running daemons (e.g. Redis) that aren't AuraOS apps.

CommandDescriptionKey flags
aura service listServices with installed + running status (NAME, SOURCE, INSTALLED, RUNNING, PORT).
aura service install <name>Install service from registry.
aura service start <name>Start detached; PID recorded under /data/aura/state/services/.
aura service stop <name>SIGTERM.
aura service status <name>Installed + running status + registry config (JSON).
aura service logs <name>Tail logs.-f, --follow
aura service uninstall <name>Stop (if running) + uninstall.

Dev tools — aura dev …

CommandDescriptionKey flags
aura dev new [appId]Scaffold a new app. Interactive wizard if appId omitted.--name, --icon, --description, --shape, --instance-mode, --sandbox, --tools, --force, --non-interactive
aura dev clone [sourceAppId] [targetAppId]Clone an existing app into a new one. Interactive wizard if the ids are omitted. Any app can be cloned — system included — but the clone always lands in user or global scope.--scope, --source-scope, --name, --icon, --description, --version, --no-rewrite-ids, --exclude-git, --strip-publish, --strip-store, --with-data, --force, --dry-run, --non-interactive, --json
aura dev validate [path]Validate one manifest, or all with --all. Runs the Zod schema.--all
aura dev clean-manifest [path]Strip manifest fields equal to schema defaults.--all, --dry-run
aura dev standalone <appId>Run an app directly with astro dev (no PRoot/shell) for fast UI iteration.

Theme — aura theme …

CommandDescriptionKey flags
aura theme listAvailable presets; active marked with .
aura theme getPrint active selection (themeIdDark, themeIdLight, colorMode).
aura theme set <themeId>Set active theme for a tone slot. Triggers live update across shell + apps.--tone <light | dark>

Content provider — aura data …

CommandDescriptionKey flags
aura data query <authority>/<resource>GET from a content provider; print JSON.
aura data write <authority>/<resource> [body]Write to a provider. Body from arg or stdin if "-".-m, --method <PUT | POST | PATCH | DELETE>
aura data watch <authority>/<resource>Follow an SSE-capable provider (?watch=1).

Event bus — aura events

CommandDescriptionKey flags
aura eventsFollow the OS event bus (live timeline of state changes).-f, --filter <pattern>

Glob patterns (app:*, theme:**) work in the filter. The event bus fan-out lives in packages/core/src/ipc/OsEventBus.ts.

Sandbox navigation — aura jump

Interactive picker: drop into a running app or service sandbox from your current terminal.

CommandDescriptionKey flags
aura jumpPick a target interactively.--no-services, --no-apps, -m, --master (straight into aura-shell)
aura jump <appId>Direct jump by app id.
aura jAlias.

Process listing — aura ps

CommandDescriptionKey flags
aura psdocker-ps-style table of running instances (INSTANCE, APP, STATE, PORT, ACTIVITIES, UPTIME).-w, --watch

System info — aura whereami, aura status

CommandDescriptionKey flags
aura whereamiWhere in the layer stack am I (host / aura-shell / proot / proot+ctnr)? Plus env, mounts, tools, CPU/memory snapshot.--json
aura statusSummary of AuraOS health: shell, apps, capabilities, services, paths.

Built-in

CommandDescription
aura completion <bash | zsh>Print shell completion script. Add to ~/.bashrc / ~/.zshrc.
aura --versionPrint CLI version.
aura --help / aura <cmd> --helpHelp for any command.

Global options

OptionDefaultEffect
--shell-url <url>http://127.0.0.1:3000Override the AuraOS shell URL. Useful when the CLI runs outside the master container (e.g. host-side scripts hitting a remote shell).