Skip to content
On this page

CLI flags ​

This page is the catalog of Adonia CLI flags. Command pages explain when to use each switch; this table is the complete list.

Shared flags live on the root adonia program and apply to every command. Stub flags apply to add and diff. init and check have command-specific flags of their own.

Shared flags ​

Pass these before or after the command name.

FlagDefaultCommandsEffect
--cwd <dir>current directoryallHost app root
-y, --yesfalseallHide “continuing” / core-install log lines. Does not prompt
--dry-runfalseallPrint the plan; write nothing. diff and check never write anyway
--registry <dir>from adonia.jsonallLocal registry directory (wins over config)
--overwritefalseall (add also declares it)Replace host files whose hash differs

--yes never reads stdin. The CLI does not wait for confirmation.

--registry must be a local directory. github:… values in adonia.json fail closed. See registry resolution.

init flags ​

These flags are on init only.

FlagDefaultEffect
--wirefalseApply import aliases, API provider, exception handler, config/modules.ts
--skip-corefalseDo not copy api, types, constants, or contracts
--scaffoldfalseInstall every feature module with stubs and routes. Implies --wire

Stub flags ​

These flags are on add and diff. add copies the selected files. diff includes them in the comparison. --with-tests and --wire-routes only affect add (diff accepts them and ignores them).

FlagEffect on add
--with-modelsCopy stubs/models/ → app/models/
--with-migrationsCopy stubs/migrations/ → database/migrations/
--with-controllersCopy controllers; implies adapters
--with-validatorsCopy validators and providers/ (Vine)
--with-adaptersCopy Lucid/SDK adapters → app/adapters/
--with-stubsmodels, migrations, controllers, validators, adapters, Vine provider, limiter stub. Not routes
--with-routesCopy stubs/routes/ and start/ (limiter example)
--wire-routesAppend import './routes/<name>.js' in start/routes.ts
--with-testsCopy colocated tests to modules/<name>/tests/

--with-stubs does not copy routes. Combine with --with-routes.

--with-controllers implies --with-adapters. --with-validators implies the Vine provider. --with-stubs implies controllers, validators, adapters, and start/.

--wire-routes requires start/routes/<name>.ts to exist (copy it with --with-routes or create it). Missing file: exit 1.

check flags ​

These flags are on check only.

FlagDefaultEffect
--strictfalseExit 1 when any warning was printed

Next steps ​

Return to a command page, or the other reference files:

  1. CLI overview
  2. adonia.json and module.json
  3. add for the copy pipeline