All commands can be run from the shell. With no arguments, ymirr starts the interactive menu.
Project & init
| Command | Description |
|---|
ymirr init | Initialize a project (Convex + ymirr.toml). Options: --name, --pulumi-name, --envs, --provider, --non-interactive. |
Deployment
| Command | Description |
|---|
ymirr status | Show project status (environments, previews, recent events). --env, --watch. |
ymirr deploy | Deploy infrastructure. --env <env>, --stack <stack>, --yes, --non-interactive, --preview-only. |
ymirr destroy | Destroy a stack. --stack <stack> (required), --yes, --non-interactive. |
Services
| Command | Description |
|---|
ymirr service add | Add a service (interactive). |
ymirr service edit | Edit an existing service (interactive). |
ymirr service remove | Remove a service (interactive). |
ymirr service list | List all services. |
ymirr service tag | Set image tag for a service. --service, --tag, --env (required); optional --project, --deploy. |
Environments
| Command | Description |
|---|
ymirr env add | Add or configure an environment (interactive). |
ymirr env edit | Edit an environment (interactive; choose section or edit all). |
ymirr env list | List environments. |
ymirr env remove | Remove an environment (interactive). |
ymirr env clone | Export environment config as a .env file. --env <name>, --out <path>. |
| Command | Description |
|---|
ymirr logs | Show deployment logs for a stack. --stack <name> (required), --follow. |
ymirr ci:gen | Generate CI/CD pipeline YAML (GitLab/GitHub). |
ymirr generate | Preview generated project_configuration.ts. --env, --stack, --out <file>. |
ymirr setup | Configure env vars and/or install global packages (interactive). |
Netrunner
| Command | Description |
|---|
ymirr netrunner [args...] | Run the Netrunner CLI. All arguments are passed through. Examples: |
| ymirr netrunner clone list |
| ymirr netrunner clone create <id> --project <slug> |
| ymirr netrunner clone destroy <id> |
| ymirr netrunner clone status <id> |
Requires @ymirr/netrunner (install via ymirr setup → Global packages). Auth uses CLI_AUTH_TOKEN or the auth CLI (ymirr login from the legacy ymirr package).
- Interactive menu — Run
ymirr with no arguments. You get Deployment Tools (when in a project), Developer Tools, Setup, and Init. Developer Tools shows fewer options when not in a configured project (only Logs, Export env file, Netrunner — clone).
- Direct commands — Use the commands above for scripts and CI. Most interactive commands (e.g.
service add, env add) still run their wizards when invoked by name.