Skip to main content

Project & Environment Commands

Client-side commands for a company's projects and execution environments. Every command here accepts the shared client options (--api-base, --api-key, --context, --profile, --json; see CLI Overview). Full flag lists are on the CLI Reference.

Projects​

vagaris project list --company-id <company-id>
vagaris project get <project-id-or-shortname>
vagaris project create --company-id <company-id> --name "..." [--description "..."] [--status planned] [--lead-agent-id <id>] [--target-date <date>] [--color <color>] [--goal-ids <id1>,<id2>] [--product-slug <slug>] [--company-default] [--env '{"KEY":"value"}']
vagaris project update <project-id> [--name "..."] [--status in_progress] [...same flags as create]
vagaris project archive <project-id>
vagaris project unarchive <project-id>
vagaris project delete <project-id>

archive / unarchive set and clear the project's archivedAt field — they are not separate server actions, so an archived project is still readable through project get and project list.

Not implemented — no server route: project manifest, project plan, project apply. A project has no server-computed desired-state manifest or plan/apply cycle today; see Known gaps.

Environments​

Execution environments (where an agent runs a project's workspace commands) — not local .env files. The vagaris env command group is the API-backed environment resource; it is distinct from the local --config/env-var printer some CLI builds also expose under the same name (see Known gaps).

vagaris env list --company-id <company-id> [--status active] [--driver ssh]
vagaris env capabilities --company-id <company-id>
vagaris env get <environment-id>
vagaris env vars
vagaris env create --company-id <company-id> --name "..." --driver local|ssh|sandbox|plugin [--description "..."] [--status active] [--driver-config '{"...":"..."}'] [--metadata '{"...":"..."}']
vagaris env update <environment-id> [--name "..."] [--driver ssh] [--status archived] [--driver-config '{"...":"..."}'] [--metadata '{"...":"..."}']
vagaris env delete <environment-id>
vagaris env probe <environment-id>
vagaris env probe-config --company-id <company-id> --driver ssh [--name "..."] [--description "..."] [--driver-config '{"...":"..."}'] [--metadata '{"...":"..."}']
vagaris env leases <environment-id> [--status active]
vagaris env lease <lease-id>

probe checks connectivity for an already-saved environment; probe-config checks connectivity for a config that has not been saved yet (the same check the create form runs before submit). leases / lease are read-only — they show which execution workspaces currently hold a lease on the environment.

Not implemented — no server route: env diff, env promote, env retire. status already accepts an "archived" value on the plain update route, but there is no lease-aware retire endpoint — retiring an environment out from under an active lease is a decision the server has to make, not the client, so it is left as a gap rather than aliased to a plain status update. See Known gaps.

Known gaps​

These are real gaps in the server today, not omissions in the CLI — recorded here so a reader does not go looking for a flag that cannot exist yet.

CommandWhy it is missing
project manifestNo server route computes or stores a project desired-state manifest.
project plan / project applyNo server-derived plan/apply primitive exists for projects (or anywhere else in the API yet).
env diffNo server route diffs an environment's declared config against its live/observed state.
env promoteNo server route promotes an environment (e.g. staging → production) as a single operation.
env retireNo server route retires an environment with lease-aware semantics; a plain env update --status archived does not check or release active leases first.

vagaris env name note: this document covers the API-backed environment-resource command group. If your CLI build also has a local, non-API env command for printing deployment environment variables, only one of the two can be registered under the top-level env name in a given build — check vagaris env --help to see which one you have.