Skip to content

CLI reference

  • Usage: aube [FLAGS] <SUBCOMMAND>

Run aube <command> --help for help in your terminal. aubr is shorthand for aube run; aubx is shorthand for aube dlx. For a guided introduction, start with getting started.

Find a command

TaskCommands
Install and change dependenciesinstall · ci · add · remove · update · dedupe · prune · fetch · import · init · link · unlink · patch · patch-commit · patch-remove · clean · purge
Run scripts and toolsrun · exec · dlx · create · test · start · stop · restart
Inspect and troubleshootview · list · why · outdated · query · peers · check · doctor · diag · deprecations · bugs
Review builds and securityapprove-builds · ignored-builds · rebuild · audit · trust · licenses · sbom
Publish packagespack · publish · version · dist-tag · access · deprecate · undeprecate · unpublish
Configure projects and runtimesconfig · runtime · node · activate · completion · login · logout · recursive · deploy
Inspect stores and pathsstore · cache · cat-file · cat-index · find-hash · bin · root · prefix
Projectsponsors

The reference records supported flags and calls out compatibility flags with limited behavior. See pnpm differences before replacing a workflow.

Global Flags

  • -C --dir <DIR> — Change to directory before running (like make -C or mise --cd)

    Aliases: --cd, --prefix

  • -F --filter <WORKSPACE> — Scope command execution to workspace packages matching a selector.

    Supports exact names (my-pkg), globs (@scope/*, *-plugin), paths (./packages/api), graph selectors (pkg..., ...pkg), git-ref selectors ([origin/main]), and exclusions (!pkg). Repeatable; matches are OR-ed.

    Currently honored by run, test, start, stop, restart, install, exec, list, outdated, publish, deploy, add, remove, update, query, rebuild, why, and implicit-script invocations.

  • -r --recursive — Run the command across every workspace package.

    Equivalent to --filter=*; if --filter is also given, --recursive is a no-op and the explicit filter wins. Honored by the same commands as --filter.

  • -v --verbose — Enable verbose/debug logging (shortcut for --loglevel debug)

  • -V --version — Print version and check for updates.

  • --color — Force colored output even when stderr is not a TTY.

    Overrides NO_COLOR / CLICOLOR=0. Mutually exclusive with --no-color.

  • --diag [MODE] — Enable cold-install deep diagnostics. Modes: summary — sum_ms / mean / max / %wall table at end trace — summary + critical path + starvation + what-if + lifecycle live — like trace, plus print every span >= 100ms to stderr live full — like trace, plus write JSONL trace to a file (defaults to ./aube-diag.jsonl)

    Quick form: --diag with no value defaults to trace. Output file path can be set via --diag-file. Threshold for live mode via --diag-threshold-ms.

  • --diag-file <PATH> — Path for --diag full JSONL trace (default: ./aube-diag.jsonl)

  • --diag-threshold-ms <MS> — Live-mode threshold: only print spans whose duration is >= N ms (default 100).

  • --fail-if-no-match — Error when a workspace selector matches no packages.

    Accepted globally; selected commands already fail on empty matches.

  • --filter-prod <PATTERN> — Production-only variant of --filter.

    Same selector grammar as --filter, but graph walks (pkg..., ...pkg) only follow dependencies / optionalDependencies / peerDependencies edges — devDependencies (and packages reachable solely through them) are skipped. Non-graph forms (exact name, glob, path, [git-ref]) behave identically to --filter. Repeatable; can be combined with --filter.

  • --loglevel <LEVEL> — Set the log level. Logs at or above this level are shown.

    Choices: trace, debug, info, warn, error, silent

  • --no-color — Disable colored output.

    Overrides FORCE_COLOR / CLICOLOR_FORCE and sets NO_COLOR=1 so child processes see the same choice.

  • --reporter <NAME> — Output format: default, append-only, ndjson, silent.

    default renders the progress UI when stderr is a TTY; append-only disables the progress UI in favor of plain line-at-a-time logs; ndjson emits one JSON object per log event on stderr and is what tooling wrappers should consume; silent suppresses all non-error output (alias for --loglevel silent).

    Choices: default, append-only, ndjson, silent

  • --silent — Suppress all non-error output (alias for --loglevel silent)

  • --workspace-root — Run from the workspace root regardless of the current package.

Flags

  • -h --help — Print help

Subcommands

MIT LicensejdxCopyright © 2026 jdx.dev