CLI Overview
Use cli overview with the current published Askr packages.
@askrjs/cli0.0.5
How to use cli overview
Run the project-local published CLI, inspect help before scripting it, and keep CI commands pinned by package-lock.json.
- Import the published @askrjs/cli entrypoint.
- Keep cli overview configuration next to the component, route, or server composition root that owns it.
- Handle pending, unavailable, cancellation, and failure states, then verify the production path.
npx askr --version
npx askr --help
npx askr create --help
npx askr openapi --checkAvailable commands
askr --help lists nine subcommands: create, add, generate, openapi, skills, ssg, outdated, update, and upgrade. create builds a new project from a template or a product prompt, add generates pages and actions into an existing one, generate produces an @askrjs/fetch client from an OpenAPI document, and the remaining commands cover API artifacts, agent skills, static builds, and dependency maintenance. Each one accepts its own --help flag for command-specific usage and examples.
Help and version
Running askr with no arguments, or with --help/-h, prints the same top-level help text: a usage line, the command table, global options, and a handful of worked examples. --version (or -v) prints the installed @askrjs/cli version by walking up from the executable's directory until it finds the package.json whose name is @askrjs/cli. An unrecognized command prints Unknown command: <name> and points you back at askr --help rather than silently doing nothing.
Project-local execution
@askrjs/cli is typically installed globally (npm install -g @askrjs/cli) so the askr command is on your PATH, but commands that touch a project -- add, skills install/sync, outdated/update/upgrade -- accept a --cwd <dir> flag to target a project directory other than the current one. This matters for scripting: a CI job or a monorepo tool can invoke askr update --cwd packages/app without changing its own working directory first. Commands discover the containing workspace from wherever --cwd (or the default cwd) points, including nested package directories.
CI usage
Two commands are built specifically for CI gating: askr openapi --check exits unsuccessfully and writes nothing if the checked-in openapi.yml is missing or differs from the generated document by even one byte, and askr outdated --json emits a single deterministic JSON object you can parse in a pipeline step. Because update and upgrade never run an install or touch a lockfile, they're safe to run in a step that's followed by your normal install-and-test job rather than needing their own sandboxed environment. --workspace and --tag flags let a CI matrix target one package or one dist-tag at a time instead of the whole tree.
Published commands
These commands come from @askrjs/cli 0.0.5. Planned generators such as route, crud, table, and form are not available commands.
| Command | Run |
|---|---|
add | askr add --help |
create | askr create --help |
generate | askr generate --help |
openapi | askr openapi --help |
skills | askr skills --help |
ssg | askr ssg --help |
outdated | askr outdated --help |
update | askr update --help |
upgrade | askr upgrade --help |