Codiac-CLI

Codiac-CLI

• Codiac-CLI
• Usage

Usage

$ npm install -g @codiac.io/codiac-cli
$ codiac COMMAND
running command...
$ codiac (--version|-v)
@codiac.io/codiac-cli/1.3.288 linux-x64 node-v22.15.1
$ codiac --help [COMMAND]
USAGE
  $ codiac COMMAND
...

• codiac asset create
• codiac asset destroy
• codiac asset get [CMD]
• codiac asset helm [SETTING]
• codiac asset list
• codiac asset mon [CMD]
• codiac asset monitor [CMD]
• codiac asset new
• codiac asset probe create [CMD]
• codiac asset recycle
• codiac asset view [CMD]
• codiac asset vol add [MOUNTPATH]
• codiac asset vol create [MOUNTPATH]
• codiac asset vol del
• codiac asset vol delete
• codiac asset vol list
• codiac asset volume add [MOUNTPATH]
• codiac asset volume create [MOUNTPATH]
• codiac asset volume del
• codiac asset volume delete
• codiac asset volume list
• codiac asset volumes del
• codiac asset volumes delete
• codiac asset volumes list
• codiac autocomplete [SHELL]
• codiac branch [NAME]
• codiac branch current
• codiac branch list
• codiac branches current
• codiac branches list
• codiac build
• codiac cab create [CABINET]
• codiac cab list
• codiac cab obliterate [CABINET]
• codiac cabinet create [CABINET]
• codiac cabinet list
• codiac cabinet obliterate [CABINET]
• codiac cfg add [SETTING]
• codiac cfg delete [SETTING]
• codiac cfg view [SETTING]
• codiac cli
• codiac cluster create [NAME]
• codiac cluster deinit [NAME]
• codiac cluster destroy [NAME]
• codiac cluster forget
• codiac cluster grant [NAME]
• codiac cluster init [NAME]
• codiac cluster list
• codiac cluster recreate [NAME]
• codiac commit [MESSAGE]
• codiac config add [SETTING]
• codiac config delete [SETTING]
• codiac config deploy
• codiac config import [SETTING]
• codiac config set [SETTING]
• codiac config view [SETTING]
• codiac csp login [PROVIDER]
• codiac csp logout [PROVIDER]
• codiac dash
• codiac dep [NAME]
• codiac dep create [URL]
• codiac dep install
• codiac dep list
• codiac dep remove [NAME]
• codiac dep source [NAME]
• codiac dep src [NAME]
• codiac dep syncup DEPENDENCY
• codiac dep unsource [NAME]
• codiac dep unsrc [NAME]
• codiac dep upgrade [DEPENDENCY]
• codiac deploy
• codiac domain map [DOMAIN]
• codiac ent list
• codiac enterprise create [CODE]
• codiac enterprise list
• codiac env add [SETTING]
• codiac enviro create [NAME]
• codiac enviro list
• codiac environment create [NAME]
• codiac environment list
• codiac fileshare capture
• codiac filestore capture
• codiac help [COMMANDS]
• codiac host map [DOMAIN]
• codiac identify [TOKENNAME]
• codiac identity [TOKENNAME]
• codiac identity delete [NAME]
• codiac identity list
• codiac identity remove [NAME]
• codiac image [IMAGENAME]
• codiac image add [IMAGENAME]
• codiac image delete IMAGENAME
• codiac image list
• codiac image patch IMAGENAME
• codiac image remove IMAGENAME
• codiac imageRegistry capture
• codiac imageRegistry forget
• codiac imageRegistry pullSecret set
• codiac imageRegistry pullSecret unset
• codiac images add [IMAGENAME]
• codiac images list
• codiac images patch IMAGENAME
• codiac images remove IMAGENAME
• codiac images version NAME
• codiac img [IMAGENAME]
• codiac img add [IMAGENAME]
• codiac img delete IMAGENAME
• codiac img list
• codiac img patch IMAGENAME
• codiac img remove IMAGENAME
• codiac init DIRECTORY
• codiac k9s
• codiac kit create [SETTING]
• codiac login
• codiac logout
• codiac merge [BRANCH]
• codiac noc cluster create [NAME]
• codiac noc cluster deinit [NAME]
• codiac noc cluster destroy [NAME]
• codiac noc cluster forget
• codiac noc cluster grant [NAME]
• codiac noc cluster init [NAME]
• codiac noc cluster list
• codiac noc cluster recreate [NAME]
• codiac pkg add [DEFINITIONFILE]
• codiac pkg delete [PACKAGENAME]
• codiac pkg list
• codiac pkg patch PACKAGENAME
• codiac pkg remove [PACKAGENAME]
• codiac portal
• codiac publish [NAME]
• codiac pull [NAME]
• codiac pullsecret
• codiac pullsecret unset
• codiac push [NAME]
• codiac run
• codiac secretStore
• codiac secretStore capture
• codiac secretStore forget
• codiac stage [FILES]
• codiac stash [FILE]
• codiac status
• codiac stop
• codiac switch [NAME]
• codiac sync [NAME]
• codiac tenant create [NAME]
• codiac tenant switch [NAME]
• codiac token [TOKENNAME]
• codiac token delete [NAME]
• codiac token list
• codiac token remove [NAME]
• codiac unstage [FILES]
• codiac update [CHANNEL]
• codiac user login
• codiac user show
• codiac version
• codiac view dash
• codiac view dashboard
• codiac view k9s
• codiac view pods
• codiac whereami
• codiac whoami

• codiac ai agent csp add
• codiac ai agent csp delete
• codiac ai agent csp list
• codiac ai agent csp ls
• codiac ai agent csp remove
• codiac ai agent csp rm
• codiac ai agent install
• codiac ai model attach
• codiac ai model install
• codiac ai model list
• codiac ai model ls
• codiac ai model remove
• codiac ai model uninstall
• codiac ai model view
• codiac asset create
• codiac asset edit
• codiac asset entrypoint
• codiac asset entrypoint delete
• codiac asset entrypoint set
• codiac asset get [CMD]
• codiac asset list
• codiac asset mon [CMD]
• codiac asset monitor [CMD]
• codiac asset new
• codiac asset obliterate
• codiac asset probe create [CMD]
• codiac asset probe delete
• codiac asset probe list
• codiac asset recycle
• codiac asset undeploy
• codiac asset view [CMD]
• codiac asset vol add [MOUNTPATH]
• codiac asset vol create [MOUNTPATH]
• codiac asset vol del
• codiac asset vol delete
• codiac asset vol list
• codiac asset volume add [MOUNTPATH]
• codiac asset volume create [MOUNTPATH]
• codiac asset volume del
• codiac asset volume delete
• codiac asset volume list
• codiac asset volumes del
• codiac asset volumes delete
• codiac asset volumes list
• codiac asset where
• codiac auth cab allow
• codiac auth cab allowed
• codiac auth cabinet allow
• codiac auth cabinet allowed
• codiac auth ent allow
• codiac auth ent allow onenvs
• codiac auth ent allowed
• codiac auth enterprise allow
• codiac auth enterprise allow onEnvironments
• codiac auth enterprise allowed
• codiac auth env allowed
• codiac auth enviro allow
• codiac auth enviro allow oncabs
• codiac auth environment allow
• codiac auth environment allow onCabinets
• codiac auth environment allowed
• codiac auth register
• codiac auth role allowed [NAME]
• codiac auth role assign
• codiac auth role create [NAME]
• codiac auth role delete [NAME]
• codiac auth role list
• codiac auth role unassign
• codiac auth user invite
• codiac auth user list
• codiac autocomplete [SHELL]
• codiac branch [NAME]
• codiac branch current
• codiac branch list
• codiac branches current
• codiac branches list
• codiac build
• codiac cab attach
• codiac cab cluster attach
• codiac cab contents
• codiac cab create [CABINET]
• codiac cab define [CABINET]
• codiac cab destroy [CABINET]
• codiac cab detach [CABINET]
• codiac cab forget [CABINET]
• codiac cab list
• codiac cab obliterate [CABINET]
• codiac cab restore
• codiac cabinet attach
• codiac cabinet cluster attach
• codiac cabinet contents
• codiac cabinet create [CABINET]
• codiac cabinet define [CABINET]
• codiac cabinet destroy [CABINET]
• codiac cabinet detach [CABINET]
• codiac cabinet forget [CABINET]
• codiac cabinet list
• codiac cabinet obliterate [CABINET]
• codiac cabinet restore
• codiac cfg add
• codiac cfg delete [SETTING]
• codiac cfg preview [SETTING]
• codiac cli
• codiac cluster agent configure [CLUSTER]
• codiac cluster agent install [CLUSTER]
• codiac cluster agent uninstall [CLUSTER]
• codiac cluster bootstrap [NAME]
• codiac cluster capture
• codiac cluster connect [CLUSTER]
• codiac cluster contents
• codiac cluster create [NAME]
• codiac cluster credentials-set [NAME]
• codiac cluster define [NAME]
• codiac cluster deinit
• codiac cluster destroy [NAME]
• codiac cluster edit [NAME]
• codiac cluster envoy configure [CLUSTER]
• codiac cluster envoy install [CLUSTER]
• codiac cluster envoy uninstall [CLUSTER]
• codiac cluster forget
• codiac cluster grant
• codiac cluster init
• codiac cluster install [CLUSTER]
• codiac cluster journal [CLUSTER]
• codiac cluster list
• codiac cluster provision [NAME]
• codiac cluster restore [NAME]
• codiac cluster stack capture [NAME]
• codiac cluster stack install [CLUSTER]
• codiac cluster stack list
• codiac cluster stack tag
• codiac cluster stack untag
• codiac cluster start [CLUSTER]
• codiac cluster stop [CLUSTER]
• codiac cluster uninstall
• codiac commit [MESSAGE]
• codiac config add
• codiac config delete [SETTING]
• codiac config deploy
• codiac config import
• codiac config preview [SETTING]
• codiac config set
• codiac config settings get
• codiac config view [SETTING]
• codiac csp creds list
• codiac csp login [PROVIDER]
• codiac csp logout [PROVIDER]
• codiac dep [NAME]
• codiac dep create [URL]
• codiac dep install
• codiac dep list
• codiac dep remove [NAME]
• codiac dep source [NAME]
• codiac dep src [NAME]
• codiac dep syncup DEPENDENCY
• codiac dep unsource [NAME]
• codiac dep unsrc [NAME]
• codiac dep upgrade [DEPENDENCY]
• codiac deploy
• codiac domain map [DOMAIN]
• codiac ent list
• codiac enterprise create [CODE]
• codiac enterprise list
• codiac env add [SETTING]
• codiac enviro cluster attach
• codiac enviro cluster detach
• codiac enviro create [NAME]
• codiac enviro delete [NAME]
• codiac enviro list
• codiac environment cluster attach
• codiac environment cluster detach
• codiac environment create [NAME]
• codiac environment delete [NAME]
• codiac environment list
• codiac fileshare capture
• codiac filestore capture
• codiac filestore forget
• codiac filestore list
• codiac help [COMMANDS]
• codiac host delete
• codiac host list [DOMAIN]
• codiac host map [DOMAIN]
• codiac host recapture [CLUSTER]
• codiac host view [DOMAIN]
• codiac identify [TOKENNAME]
• codiac identity [TOKENNAME]
• codiac identity delete [NAME]
• codiac identity list
• codiac identity remove [NAME]
• codiac image [IMAGENAME]
• codiac image add [IMAGENAME]
• codiac image delete IMAGENAME
• codiac image list
• codiac image patch IMAGENAME
• codiac image remove IMAGENAME
• codiac image version bump NAME
• codiac image version get NAME
• codiac imageRegistry capture
• codiac imageRegistry edit
• codiac imageRegistry forget
• codiac imageRegistry list
• codiac imageRegistry pullSecret set
• codiac imageRegistry pullSecret unset
• codiac images add [IMAGENAME]
• codiac images list
• codiac images patch IMAGENAME
• codiac images remove IMAGENAME
• codiac images version NAME
• codiac images version bump NAME
• codiac img [IMAGENAME]
• codiac img add [IMAGENAME]
• codiac img delete IMAGENAME
• codiac img list
• codiac img patch IMAGENAME
• codiac img remove IMAGENAME
• codiac img version bump NAME
• codiac img version get NAME
• codiac import cluster
• codiac infrx cab create [CABINET]
• codiac infrx cab list
• codiac infrx cab obliterate [CABINET]
• codiac infrx cabinet create [CABINET]
• codiac infrx cabinet list
• codiac infrx cabinet obliterate [CABINET]
• codiac infrx enviro cluster attach
• codiac infrx enviro cluster detach
• codiac infrx enviro create [NAME]
• codiac infrx enviro delete [NAME]
• codiac infrx enviro list
• codiac infrx environment cluster attach
• codiac infrx environment cluster detach
• codiac infrx environment create [NAME]
• codiac infrx environment delete [NAME]
• codiac infrx environment list
• codiac ingress recapture [CLUSTER]
• codiac init DIRECTORY
• codiac kit create
• codiac login
• codiac logout
• codiac merge [BRANCH]
• codiac noc cluster capture
• codiac noc cluster create [NAME]
• codiac noc cluster credentials-set [NAME]
• codiac noc cluster define [NAME]
• codiac noc cluster deinit
• codiac noc cluster destroy [NAME]
• codiac noc cluster edit [NAME]
• codiac noc cluster forget
• codiac noc cluster grant
• codiac noc cluster init
• codiac noc cluster journal [CLUSTER]
• codiac noc cluster list
• codiac noc cluster restore [NAME]
• codiac pkg add [DEFINITIONFILE]
• codiac pkg delete [PACKAGENAME]
• codiac pkg list
• codiac pkg patch PACKAGENAME
• codiac pkg remove [PACKAGENAME]
• codiac portal
• codiac probe create [CMD]
• codiac publish [NAME]
• codiac pull [NAME]
• codiac pullsecret
• codiac pullsecret unset
• codiac push [NAME]
• codiac pvc create
• codiac pvc delete
• codiac pvc get
• codiac pvc list
• codiac relay-version
• codiac run
• codiac secretStore
• codiac secretStore capture
• codiac secretStore forget
• codiac secretStore list
• codiac shell init
• codiac skill install
• codiac skill path
• codiac skill show
• codiac snapshot deploy
• codiac snapshot list
• codiac snapshot tag
• codiac snapshot untag
• codiac stage [FILES]
• codiac stash [FILE]
• codiac status
• codiac stop
• codiac switch [NAME]
• codiac sync [NAME]
• codiac tenant create [NAME]
• codiac tenant switch [CODE]
• codiac token [TOKENNAME]
• codiac token delete [NAME]
• codiac token list
• codiac token remove [NAME]
• codiac unstage [FILES]
• codiac update [CHANNEL]
• codiac user login
• codiac user show
• codiac version
• codiac whereami
• codiac whoami

codiac ai agent csp add

Adds a cloud (CSP) login to an agent, storing the credentials in a secret store and redeploying the agent to pick them up.

USAGE
  $ codiac ai agent csp add [-h] [-e <value>] [-c <value>] [-a <value>] [-p azure|aws] [-l <value>] [-s <value>]
    [--silent]

FLAGS
  -a, --agent=<value>       Name of the agent asset.
  -c, --cabinet=<value>     Cabinet the agent is deployed into.
  -e, --enterprise=<value>  Enterprise the agent belongs to.
  -h, --help                Show CLI help.
  -l, --login=<value>       Name for this login (defaults to the provider). Lets an agent hold several.
  -p, --provider=<option>   Cloud this login authenticates against.
                            <options: azure|aws>
  -s, --store=<value>       Secret store to write the credentials to.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.

DESCRIPTION
  Adds a cloud (CSP) login to an agent, storing the credentials in a secret store and redeploying the agent to pick them
  up.

EXAMPLES
  Add a cloud login to an agent.

    $ codiac ai agent csp add --agent hermes-agent --cabinet bens-agent

  Add a second, named login.

    $ codiac ai agent csp add --agent hermes-agent --cabinet bens-agent --login data-aws --provider aws

See code: src/commands/ai/agent/csp/add.ts

codiac ai agent csp delete

Removes a cloud (CSP) login from an agent's configuration. The secret is left in its store.

USAGE
  $ codiac ai agent csp delete [-h] [-e <value>] [-a <value>] [-l <value>] [--silent]

FLAGS
  -a, --agent=<value>       Name of the agent asset.
  -e, --enterprise=<value>  Enterprise the agent belongs to.
  -h, --help                Show CLI help.
  -l, --login=<value>       Name of the cloud login to remove (see `cod ai agent csp list`).
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.

DESCRIPTION
  Removes a cloud (CSP) login from an agent's configuration. The secret is left in its store.

ALIASES
  $ codiac ai agent csp remove
  $ codiac ai agent csp rm

EXAMPLES
  Remove a named cloud login from an agent.

    $ codiac ai agent csp delete --agent hermes-agent --login prod-az

See code: src/commands/ai/agent/csp/delete.ts

codiac ai agent csp list

Lists the cloud (CSP) logins configured for an agent, without revealing any secret values.

USAGE
  $ codiac ai agent csp list [-h] [-e <value>] [-a <value>] [--silent]

FLAGS
  -a, --agent=<value>       Name of the agent asset.
  -e, --enterprise=<value>  Enterprise the agent belongs to.
  -h, --help                Show CLI help.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.

DESCRIPTION
  Lists the cloud (CSP) logins configured for an agent, without revealing any secret values.

ALIASES
  $ codiac ai agent csp ls

EXAMPLES
  List the cloud logins on an agent.

    $ codiac ai agent csp list --agent hermes-agent

See code: src/commands/ai/agent/csp/list.ts

codiac ai agent csp ls

Lists the cloud (CSP) logins configured for an agent, without revealing any secret values.

USAGE
  $ codiac ai agent csp ls [-h] [-e <value>] [-a <value>] [--silent]

FLAGS
  -a, --agent=<value>       Name of the agent asset.
  -e, --enterprise=<value>  Enterprise the agent belongs to.
  -h, --help                Show CLI help.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.

DESCRIPTION
  Lists the cloud (CSP) logins configured for an agent, without revealing any secret values.

ALIASES
  $ codiac ai agent csp ls

EXAMPLES
  List the cloud logins on an agent.

    $ codiac ai agent csp ls --agent hermes-agent

codiac ai agent csp remove

Removes a cloud (CSP) login from an agent's configuration. The secret is left in its store.

USAGE
  $ codiac ai agent csp remove [-h] [-e <value>] [-a <value>] [-l <value>] [--silent]

FLAGS
  -a, --agent=<value>       Name of the agent asset.
  -e, --enterprise=<value>  Enterprise the agent belongs to.
  -h, --help                Show CLI help.
  -l, --login=<value>       Name of the cloud login to remove (see `cod ai agent csp list`).
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.

DESCRIPTION
  Removes a cloud (CSP) login from an agent's configuration. The secret is left in its store.

ALIASES
  $ codiac ai agent csp remove
  $ codiac ai agent csp rm

EXAMPLES
  Remove a named cloud login from an agent.

    $ codiac ai agent csp remove --agent hermes-agent --login prod-az

codiac ai agent csp rm

Removes a cloud (CSP) login from an agent's configuration. The secret is left in its store.

USAGE
  $ codiac ai agent csp rm [-h] [-e <value>] [-a <value>] [-l <value>] [--silent]

FLAGS
  -a, --agent=<value>       Name of the agent asset.
  -e, --enterprise=<value>  Enterprise the agent belongs to.
  -h, --help                Show CLI help.
  -l, --login=<value>       Name of the cloud login to remove (see `cod ai agent csp list`).
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.

DESCRIPTION
  Removes a cloud (CSP) login from an agent's configuration. The secret is left in its store.

ALIASES
  $ codiac ai agent csp remove
  $ codiac ai agent csp rm

EXAMPLES
  Remove a named cloud login from an agent.

    $ codiac ai agent csp rm --agent hermes-agent --login prod-az

codiac ai agent install

Provisions a stateful Codiac agent workload (openclaw, hermes, or byoa) into an enterprise cabinet.

USAGE
  $ codiac ai agent install [-h] [-e <value>] [-t openclaw|hermes|byoa] [-c <value>] [-n <value>] [-g] [--naming
    <value>] [--domain <value>] [--input <value>] [--take-defaults | --silent] [--echo | --to-script | ]

FLAGS
  -c, --cabinet=<value>         Cabinet (environment) into which the agent workload is deployed.
  -e, --enterpriseCode=<value>  Code name identifying the target enterprise.
  -g, --[no-]ingress            Expose the agent web terminal through an ingress host (use --no-ingress to keep it
                                cluster-internal).
  -h, --help                    Show CLI help.
  -n, --name=<value>            Asset name for the agent workload (defaults to <type>-agent).
  -t, --type=<option>           Agent framework to install: openclaw, hermes, or byoa (bring-your-own-agent).
                                <options: openclaw|hermes|byoa>
  --domain=<value>              Domain to use with the host-naming strategy for the ingress host.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --input=<value>...            Pre-supply a needs_action input as key=value (repeatable), e.g. --input
                                openRouterKey=sk-... . Lets --silent/headless runs resolve secret/decision prompts
                                without interaction.
  --naming=<value>              Host-naming strategy to use for the ingress host (prompted during install when omitted).
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --take-defaults               Prevents prompting for confirmation on parameters that were passed in or were
                                automatically set to default values (Irrelevant in --silent mode).  This behavior does
                                NOT apply to scenarios where the command needs to override invalid user input; such
                                cases will always prompt for confirmation.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Provisions a stateful Codiac agent workload (openclaw, hermes, or byoa) into an enterprise cabinet.

EXAMPLES
  Install a Hermes agent into the dev cabinet of the ben enterprise.

    $ codiac ai agent install -e ben -t hermes -c dev

  Non-interactive (scripted) invocation. Ingress defaults on, so a host-naming strategy must be given explicitly;
  shared_ingress_ip needs no --domain.

    $ codiac ai agent install -e ben -t hermes -c dev --silent --naming shared_ingress_ip

  Renders the equivalent silent command and then executes.

    $ codiac ai agent install -e ben -t hermes -c dev --echo

  Renders the equivalent silent command without executing.

    $ codiac ai agent install -e ben -t hermes -c dev --to-script

See code: src/commands/ai/agent/install.ts

codiac ai model attach

Wires an already-provisioned model into an already-installed agent (writes the model endpoint onto the agent and redeploys it so it uses the private model).

USAGE
  $ codiac ai model attach [-h] [-e <value>] [-m <value>] [--agent <value>] [-c <value>] [--silent | --echo |
    --to-script]

FLAGS
  -c, --cabinet=<value>         Cabinet the model and agent are deployed in.
  -e, --enterpriseCode=<value>  Code name identifying the target enterprise.
  -h, --help                    Show CLI help.
  -m, --model=<value>           Handle of the provisioned model to wire in.
  --agent=<value>               Name of the already-installed agent to wire the model into.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Wires an already-provisioned model into an already-installed agent (writes the model endpoint onto the agent and
  redeploys it so it uses the private model).

EXAMPLES
  Wire the qwen3-dev model into the hermes-agent in the dev cabinet.

    $ codiac ai model attach -e ben -m qwen3-dev --agent hermes-agent -c dev

  Non-interactive (scripted) invocation.

    $ codiac ai model attach -e ben -m qwen3-dev --agent hermes-agent -c dev --silent

See code: src/commands/ai/model/attach.ts

codiac ai model install

Provisions a private LLM into an enterprise cabinet — either an in-cluster (ClusterIP-only) catalog model served via Ollama, or a registered bring-your-own OpenAI-compatible endpoint.

USAGE
  $ codiac ai model install [-h] [-e <value>] [--source served|byo] [-m <value>] [--runtime cpu|gpu] [--base-url
    <value>] [--key <value>] [-c <value>] [-n <value>] [--attach existing|new|none] [--agent <value>] [--framework
    <value>] [--input <value>] [--take-defaults | --silent] [--echo | --to-script | ]

FLAGS
  -c, --cabinet=<value>         Cabinet (environment) the model is deployed into (served) or registered against (byo).
  -e, --enterpriseCode=<value>  Code name identifying the target enterprise.
  -h, --help                    Show CLI help.
  -m, --model=<value>           Catalog model kind to serve when --source served (one of: qwen3, gpt-oss, glm,
                                deepseek-r1).
  -n, --name=<value>            Handle for the model workload (server-assigns a default when omitted).
  --agent=<value>               Name of the already-installed agent to wire the model into (required with --attach
                                existing).
  --attach=<option>             Wire the model to an agent once ready: attach to an existing agent, install a new one,
                                or neither (defaults to none).
                                <options: existing|new|none>
  --base-url=<value>            OpenAI-compatible base URL of the endpoint to register when --source byo (e.g.
                                https://host/v1).
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --framework=<value>           Agent framework to install and wire to the model (required with --attach new).
  --input=<value>...            Pre-supply a needs_action input as key=value (repeatable), e.g. --input
                                skipReachabilityCheck=true . Lets --silent/headless runs resolve secret/decision prompts
                                without interaction.
  --key=<value>                 API key for the BYO endpoint (prompted as a secret during install when omitted; stored
                                server-side as a secret).
  --runtime=<option>            Compute tier for a served model: cpu-only, or scheduled onto a GPU node pool.
                                <options: cpu|gpu>
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --source=<option>             Serve a license-clean catalog model in-cluster (served) or register an external
                                OpenAI-compatible endpoint (byo).
                                <options: served|byo>
  --take-defaults               Prevents prompting for confirmation on parameters that were passed in or were
                                automatically set to default values (Irrelevant in --silent mode).  This behavior does
                                NOT apply to scenarios where the command needs to override invalid user input; such
                                cases will always prompt for confirmation.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Provisions a private LLM into an enterprise cabinet — either an in-cluster (ClusterIP-only) catalog model served via
  Ollama, or a registered bring-your-own OpenAI-compatible endpoint.

EXAMPLES
  Serve the Qwen3 catalog model (CPU) into the dev cabinet of the ben enterprise.

    $ codiac ai model install -e ben --source served -m qwen3 --runtime cpu -c dev

  Non-interactive (scripted) served install; a served model needs both --model and --runtime.

    $ codiac ai model install -e ben --source served -m qwen3 --runtime cpu -c dev --attach none --silent

  Register a BYO OpenAI-compatible endpoint and attach it to an existing agent.

    $ codiac ai model install -e ben --source byo --base-url https://host/v1 --key sk-... -c dev --attach existing \
      --agent hermes-agent --silent

  Renders the equivalent silent command and then executes.

    $ codiac ai model install -e ben --source served -m qwen3 --runtime cpu -c dev --echo

  Renders the equivalent silent command without executing.

    $ codiac ai model install -e ben --source served -m qwen3 --runtime cpu -c dev --to-script

See code: src/commands/ai/model/install.ts

codiac ai model list

Lists the private models provisioned for an enterprise — both in-cluster (served) catalog models and registered bring-your-own (BYO) OpenAI-compatible endpoints.

USAGE
  $ codiac ai model list [-h] [-e <value>] [-c <value>] [-o text|tree|json|yaml|tsv|csv] [-q <value>] [--silent |
    --echo | --to-script]

FLAGS
  -c, --cabinet=<value>         Restrict the listing to one cabinet (also resolves served endpoints to that cabinet's
                                in-cluster service DNS).
  -e, --enterpriseCode=<value>  Code name identifying the target enterprise.
  -h, --help                    Show CLI help.
  -o, --output=<option>         Format in which to render the results.
                                <options: text|tree|json|yaml|tsv|csv>
  -q, --query=<value>           JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Lists the private models provisioned for an enterprise — both in-cluster (served) catalog models and registered
  bring-your-own (BYO) OpenAI-compatible endpoints.

ALIASES
  $ codiac ai model ls

EXAMPLES
  Simple listing for an enterprise.

    $ codiac ai model list -e ben

  Only the models in one cabinet.

    $ codiac ai model list -e ben -c dev

  Handles only.

    $ codiac ai model list -e ben -q '[].handle'

  Filter to served models.

    $ codiac ai model list -e ben -q "[?mode == 'served']"

  Export as YAML.

    $ codiac ai model list -e ben -o yaml

  Non-interactive invocation.

    $ codiac ai model list -e ben --silent

See code: src/commands/ai/model/list.ts

codiac ai model ls

Lists the private models provisioned for an enterprise — both in-cluster (served) catalog models and registered bring-your-own (BYO) OpenAI-compatible endpoints.

USAGE
  $ codiac ai model ls [-h] [-e <value>] [-c <value>] [-o text|tree|json|yaml|tsv|csv] [-q <value>] [--silent |
    --echo | --to-script]

FLAGS
  -c, --cabinet=<value>         Restrict the listing to one cabinet (also resolves served endpoints to that cabinet's
                                in-cluster service DNS).
  -e, --enterpriseCode=<value>  Code name identifying the target enterprise.
  -h, --help                    Show CLI help.
  -o, --output=<option>         Format in which to render the results.
                                <options: text|tree|json|yaml|tsv|csv>
  -q, --query=<value>           JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Lists the private models provisioned for an enterprise — both in-cluster (served) catalog models and registered
  bring-your-own (BYO) OpenAI-compatible endpoints.

ALIASES
  $ codiac ai model ls

EXAMPLES
  Simple listing for an enterprise.

    $ codiac ai model ls -e ben

  Only the models in one cabinet.

    $ codiac ai model ls -e ben -c dev

  Handles only.

    $ codiac ai model ls -e ben -q '[].handle'

  Filter to served models.

    $ codiac ai model ls -e ben -q "[?mode == 'served']"

  Export as YAML.

    $ codiac ai model ls -e ben -o yaml

  Non-interactive invocation.

    $ codiac ai model ls -e ben --silent

codiac ai model remove

Removes a provisioned model. A served (in-cluster) model is undeployed from its cabinet (its asset is destroyed); BYO endpoints are not yet removable here.

USAGE
  $ codiac ai model remove [-h] [-e <value>] [-m <value>] [-c <value>] [--silent | --echo | --to-script]

FLAGS
  -c, --cabinet=<value>         Cabinet the model was deployed into (served) or registered against (byo).
  -e, --enterpriseCode=<value>  Code name identifying the target enterprise.
  -h, --help                    Show CLI help.
  -m, --model=<value>           Handle of the model to remove.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Removes a provisioned model. A served (in-cluster) model is undeployed from its cabinet (its asset is destroyed); BYO
  endpoints are not yet removable here.

ALIASES
  $ codiac ai model remove

EXAMPLES
  Undeploy the served qwen3-dev model from the dev cabinet.

    $ codiac ai model remove -e ben -m qwen3-dev -c dev

  Non-interactive (scripted) invocation.

    $ codiac ai model remove -e ben -m qwen3-dev -c dev --silent

codiac ai model uninstall

Removes a provisioned model. A served (in-cluster) model is undeployed from its cabinet (its asset is destroyed); BYO endpoints are not yet removable here.

USAGE
  $ codiac ai model uninstall [-h] [-e <value>] [-m <value>] [-c <value>] [--silent | --echo | --to-script]

FLAGS
  -c, --cabinet=<value>         Cabinet the model was deployed into (served) or registered against (byo).
  -e, --enterpriseCode=<value>  Code name identifying the target enterprise.
  -h, --help                    Show CLI help.
  -m, --model=<value>           Handle of the model to remove.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Removes a provisioned model. A served (in-cluster) model is undeployed from its cabinet (its asset is destroyed); BYO
  endpoints are not yet removable here.

ALIASES
  $ codiac ai model remove

EXAMPLES
  Undeploy the served qwen3-dev model from the dev cabinet.

    $ codiac ai model uninstall -e ben -m qwen3-dev -c dev

  Non-interactive (scripted) invocation.

    $ codiac ai model uninstall -e ben -m qwen3-dev -c dev --silent

See code: src/commands/ai/model/uninstall.ts

codiac ai model view

Shows the details of a single provisioned model (served or BYO) by its handle.

USAGE
  $ codiac ai model view [-h] [-e <value>] [-m <value>] [-c <value>] [-o text|json|yaml] [-q <value>] [--silent |
    --echo | --to-script]

FLAGS
  -c, --cabinet=<value>         Cabinet the model lives in (resolves a served endpoint to that cabinet's in-cluster
                                service DNS).
  -e, --enterpriseCode=<value>  Code name identifying the target enterprise.
  -h, --help                    Show CLI help.
  -m, --model=<value>           Handle of the model to view.
  -o, --output=<option>         Format in which to render the result.
                                <options: text|json|yaml>
  -q, --query=<value>           JMESPath expression to reshape the result (see jmespath.org).
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the details of a single provisioned model (served or BYO) by its handle.

EXAMPLES
  View a model by handle.

    $ codiac ai model view -e ben -m qwen3-dev

  View as JSON.

    $ codiac ai model view -e ben -m qwen3-dev -o json

  Just the endpoint.

    $ codiac ai model view -e ben -m qwen3-dev -q endpoint

  Non-interactive invocation.

    $ codiac ai model view -e ben -m qwen3-dev --silent

See code: src/commands/ai/model/view.ts

codiac asset create

Creates a new asset in the given enterprise from an image that exists in a container registry.

USAGE
  $ codiac asset create [-h] [--chart <value> | [-k <value> | -i <value> | -r <value>] |  | ] [--chart-repo
    <value> |  |  | ] [-n <value>] [-c <value>] [-e <value>] [-p <value>] [--private -g] [-o] [--allow-http]
    [--disable-https] [--helm] [--deploy-condition-because <value> --deploy-condition <value>] [--take-defaults |
    [--silent | --echo | --to-script]]

FLAGS
  -c, --code=<value>
      The host name to assign this asset in the domain url.  eg: 'myasset' in 'myasset.your-domain.com' (Optional:
      defaults to the asset name).

  -e, --enterprise=<value>
      The name of the enterprise in which to create this asset. (defaults to the current enterprise context)

  -g, --hasIngress
      Declaration that the asset service is to be accessible from outside the cluster (optional: defaults to false).

  -h, --help
      Show CLI help.

  -i, --image=<value>
      The image name including scope prefix if applicable (eg: '@yourCompany/your-api-image').

  -k, --kit=<value>
      The name of the kit (with library prefix, eg: 'library/kitName') to use to create the asset.  Use '?' to be prompted
      for a kit (Optional: used instead of calling for the image).

  -n, --name=<value>
      The name to give the enterprise asset (Optional: defaults to the image name without the scope prefix).

  -o, --routedWithoutName
      Indicates that this asset will be the base ingress against your DNS. eg: true services yourwebsite.com (as
      root/naked) (optional: defaults to false).

  -p, --port=<value>...
      The default port number (from 1 to 65535) to assign the asset when deployed to a cabinet (optional).  To specify
      port forwarding (betw the service and container), use format: `<service-port>:<container-port>`, eg: `3555:80`

  -r, --registry=<value>
      The container registry in which the image exists (defaults to docker hub).

  --allow-http
      (Advanced) Enable this setting to allow http (ie: non-SSL/TLS) requests in through the ingress controller without
      getting redirected to https.  That is, Setting this to true will prevent the ingress controller from invoking an
      automatic redirect to https on any inbound http requests. (optional: defaults to false).

  --chart=<value>
      (Helm assets only) Name of the Helm chart to base the asset on, in place of a container image. Use with --helm.

  --chart-repo=<value>
      (Helm assets only) Codiac registry code of the Helm chart repository that publishes the chart. Use with --helm and
      --chart.

  --deploy-condition=<value>
      JSONata expression evaluated at deploy time; when falsy the asset is skipped rather than deployed (see
      https://jsonata.org for syntax). Uses the same expression context as config conditions: cabinet, cluster,
      environment, and asset variables are all in scope.

  --deploy-condition-because=<value>
      Human-readable explanation shown in the deploy output when this asset is skipped.

  --disable-https
      (Advanced) (optional: defaults to false) Enable this setting to remove support for https (aka: SSL/TLS) in the
      ingress controller.  Use this setting when tls terminates upstream of the cluster and its ingress controller.
      Setting this flag DOES NOT automatically set the `--allow-http` flag, so be diligent when using it.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --helm
      Indicates that this asset will be base on a Helm chart instead of a container (optional: defaults to false).

  --private
      (for use when hasIngress is also set) Prevents access from the internet.  That is, declares that asset service to
      only be accessible through ingress on internal networks (optional: defaults to false).  Useful for enabling private
      "east-west" (cross-cluster) communications without going out to the internet.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Creates a new asset in the given enterprise from an image that exists in a container registry.

ALIASES
  $ codiac asset new

EXAMPLES
  Create an asset interactively.

    $ codiac asset create

  Create an asset with a deploy condition so it is skipped on AKS clusters (which include metrics-server natively).

    $ codiac asset create -e myEnterprise -n metrics-server --deploy-condition "cluster.provider != 'azure'" \
      --deploy-condition-because 'AKS clusters include metrics-server natively.'

  Create an asset that only deploys to production environments.

    $ codiac asset create -e myEnterprise -n my-api --deploy-condition "environment.name = 'production'"

  Create a Helm-typed asset from a chart in a captured chart repository.

    $ codiac asset create -e myEnterprise -n redis --helm --chart redis --chart-repo bitnami --silent

See code: src/commands/asset/create.ts

codiac asset edit

Changes asset attributes.

USAGE
  $ codiac asset edit [-e <value>] [-c <value>] [-r <value>] [--pod-filter <value>] [--remove-pod-filter]
    [--deploy-condition-because <value> --deploy-condition <value>] [--remove-deploy-condition | ] [--echo | --to-script
    | [--silent -n <value>]]

FLAGS
  -c, --code=<value>
      The host name to assign this asset in the domain url.  eg: 'myasset' in 'myasset.your-domain.com' (Optional:
      defaults to the asset name).

  -e, --enterprise=<value>
      The name of the enterprise in which this asset resides. (defaults to the current enterprise context).  NOTE: The
      enterprise assignment for an asset is immutable and cannot be modified; this flag is used only for identifying the
      asset.

  -n, --name=<value>
      The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified; this flag is used only for
      identifying the asset.

  -r, --registry=<value>
      Re-point this asset at a different container registry, given by its Codiac registry CODE (run `cod imageRegistry
      list`; NOT the registry url). Re-resolves the asset's embedded registry reference — use this after correcting a
      registry url so the asset picks up the fix.

  --deploy-condition=<value>
      JSONata expression evaluated at deploy time; when falsy the asset is skipped rather than deployed (see
      https://jsonata.org for syntax). Uses the same expression context as config conditions: cabinet, cluster,
      environment, and asset variables are all in scope.

  --deploy-condition-because=<value>
      Human-readable explanation shown in the deploy output when this asset is skipped.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --pod-filter=<value>...
      Label selector identifying the pods that belong to this asset, as comma-separated key=value pairs (eg:
      'app.kubernetes.io/name=rabbitmq,app.kubernetes.io/component=rabbitmq'). Needed when a chart's workload is created
      by an OPERATOR rather than by helm — the operator labels its pods after its custom resource, which Codiac cannot
      infer from the asset name. Repeat the flag for an asset that runs several kinds of pod.

  --remove-deploy-condition
      Removes any existing deploy condition from this asset so it always deploys.

  --remove-pod-filter
      Clears any pod filters, reverting this asset to Codiac's built-in deployment-labeling convention.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Changes asset attributes.

EXAMPLES
  Edit an asset interactively.

    $ codiac asset edit

  Edit a specific asset.

    $ codiac asset edit -e main -n my-api

  Set a deploy condition so the asset is skipped on AKS clusters (which include metrics-server natively).

    $ codiac asset edit -e myEnterprise -n metrics-server --deploy-condition "cluster.provider != 'azure'" \
      --deploy-condition-because 'AKS clusters include metrics-server natively.' --silent

  Set a deploy condition so the asset only deploys in production.

    $ codiac asset edit -e myEnterprise -n my-api --deploy-condition "environment.name = 'production'" --silent

  Remove a deploy condition so the asset always deploys.

    $ codiac asset edit -e myEnterprise -n my-api --remove-deploy-condition --silent

  Re-point an asset at a corrected registry (by its Codiac code, not its url).

    $ codiac asset edit -e myEnterprise -n my-api --registry devCodiacContainers --silent

See code: src/commands/asset/edit.ts

codiac asset entrypoint

Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).

USAGE
  $ codiac asset entrypoint [-e <value>] [-d <value>] [-c <value>] [-c <value>] [-v <value>] [--echo | --to-script |
    [--silent -a <value>]]

FLAGS
  -a, --asset=<value>          The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified;
                               this flag is used only for identifying the asset.
  -c, --arg=<value>...         Gets passed to the entryPointCommand.  Often, the entrypointCommand opens a shell,
                               allowing this to be the command to run inside the shell,       eg: `--command="/bin/sh"
                               --arg="-c ls -a"` which yields: `/bin/sh -c ls -a`
  -c, --command=<value>        The command to run.  Not executed within a shell.
  -d, --workdir=<value>        (optional) Folder path within the image from which to execute the command. Overrides the
                               default working directory specified by the container image.
  -e, --enterprise=<value>     The name of the enterprise in which this asset resides. (defaults to the current
                               enterprise context).  NOTE: The enterprise assignment for an asset is immutable and
                               cannot be modified; this flag is used only for identifying the asset.
  -v, --version-range=<value>  (optional) The semantic version rule describing which versions of the asset will get this
                               entrypoint applied.  (eg: Just this one: `1.2.3`, or this one and any future patches:
                               `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one `<1.2.3` , or
                               any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in
                               quotes if it has any spaces in it.
  --echo                       Echo interaction mode; renders the equivalent non-interactive cli command for future use
                               before final execution.
  --silent                     Non-Interactive mode; executes without any user interaction and fails on any missing or
                               invalid arguments.
  --to-script                  Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                               execution.

DESCRIPTION
  Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image
  elements specified using CMD)).

ALIASES
  $ codiac asset entrypoint

EXAMPLES
  Interactive

    $ codiac asset entrypoint

  Interactive, preset for the a specific asset.

    $ codiac asset entrypoint -a my-api

  Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.

    $ codiac asset entrypoint -e ml -a my-worker

  Invoking an executable from within a bash shell (this mock scenario just imports some credentials and workflows and
  once complete, the image shuts down)

    $ codiac asset entrypoint -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe import:credentials \
      --separate --input=/backup/credentials && myexe import:workflow --separate --input=/backup/workflows'

  Same as above but non-interactive (for use in scripts and pipelines)

    $ codiac asset entrypoint --silent -e ml -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe \
      import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate \
      --input=/backup/workflows'

codiac asset entrypoint delete

Removes an existing override of the image startup command for this asset (restores the original ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).

U