Aller au contenu
greentic.ai Greentic Docs

gtc CLI reference

{/* AUTO-GENERATED by scripts/sync-cli-help.mjs — do not edit by hand. /} {/ Curated narrative for this CLI lives under src/content/docs/cli/. */}

Binary version: gtc 1.0.14 Greentic toolchain release: 1.0.15 (stable) [sha256:3f5acb3d71d2b71d7a5facb2ab28f7daa325bfc38bd566ba3f104b52aae4e592]

This page mirrors the CLI’s --help output so it stays accurate against the installed binary. If you’re looking for narrative and examples, see the curated pages linked in the sidebar.

Root help

Section intitulée « Root help »
Greentic CLI router (thin launcher).
Usage: gtc [OPTIONS] [COMMAND]


Commands:
  version       Print version information.
  doctor        Check that required Greentic binaries are available in PATH.
  docs          Documentation and generated-schema maintenance helpers.
  install       Install Greentic tools and optionally tenant-authorized artifacts.
  update        Force-update all Greentic companion binaries to the latest 0.4.x version.
  add-admin     Register an admin client certificate identity for a local bundle.
  remove-admin  Remove an admin client certificate identity from a local bundle.
  admin         Admin plane helpers.
  start         Start a bundle from local or remote reference.
  stop          Stop a bundle runtime or destroy a deployed environment.
  dev           Pass through to greentic-dev.
  op            Pass through to greentic-operator.
  wizard        Open the Greentic wizard menu.
  setup         Pass through to greentic-setup (bundle lifecycle management).
  help          Print this message or the help of the given subcommand(s)


Options:
  -h, --help            Print help
  -V, --version         Print version
      --locale <BCP47>  UI locale for gtc help/output (BCP-47 tag).
      --debug-router    Print resolved binary and args to stderr before exec.

Subcommands

Section intitulée « Subcommands »

gtc version

Section intitulée « gtc version »
Print version information.
Usage: gtc version [OPTIONS]


Options:
  -h, --help            Print help
  -V, --version         Print version
      --locale <BCP47>  UI locale for gtc help/output (BCP-47 tag).
      --debug-router    Print resolved binary and args to stderr before exec.

gtc doctor

Section intitulée « gtc doctor »
Check that required Greentic binaries are available in PATH.
Usage: gtc doctor [OPTIONS]


Options:
  -h, --help            Print help
  -V, --version         Print version
      --locale <BCP47>  UI locale for gtc help/output (BCP-47 tag).
      --debug-router    Print resolved binary and args to stderr before exec.

gtc docs

Section intitulée « gtc docs »
Documentation and generated-schema maintenance helpers.
Usage: gtc docs [OPTIONS] [COMMAND]


Commands:
  sync-schemas  Refresh generated schema docs under docs/04-schemas/.


Options:
  -h, --help            Print help
  -V, --version         Print version
      --locale <BCP47>  UI locale for gtc help/output (BCP-47 tag).
      --debug-router    Print resolved binary and args to stderr before exec.

gtc install

Section intitulée « gtc install »
Install Greentic tools and optionally tenant-authorized artifacts.
Usage: gtc install [OPTIONS]


Options:
  -h, --help               Print help
      --tenant <TENANT>    Tenant identifier for authorized installs.
      --key <KEY>          Authorization key for the specified tenant.
  -V, --version            Print version
      --channel <CHANNEL>  Toolchain release channel to install (default: stable).
      --locale <BCP47>     UI locale for gtc help/output (BCP-47 tag).
      --debug-router       Print resolved binary and args to stderr before exec.
      --release <RELEASE>  Pinned Greentic toolchain release to install.
      --manifest <PATH>    Local Greentic toolchain manifest JSON to install.
      --force              Reinstall even if the resolved toolchain digest is already installed.
      --dry-run            Print planned toolchain install actions without executing them.

gtc update

Section intitulée « gtc update »
Force-update all Greentic companion binaries to the latest 0.4.x version.
Usage: gtc update [OPTIONS]


Options:
  -h, --help            Print help
  -V, --version         Print version
      --locale <BCP47>  UI locale for gtc help/output (BCP-47 tag).
      --debug-router    Print resolved binary and args to stderr before exec.

gtc add-admin

Section intitulée « gtc add-admin »
Register an admin client certificate identity for a local bundle.
Usage: gtc add-admin [OPTIONS] --cn <CLIENT_CN> --public-key-file <PATH> <BUNDLE_REF>


Arguments:
  <BUNDLE_REF>  Local bundle directory to update.


Options:
      --cn <CLIENT_CN>          Client certificate Common Name allowed to access the admin API.
  -h, --help                    Print help
      --name <ADMIN_NAME>       Optional human-readable admin label.
  -V, --version                 Print version
      --locale <BCP47>          UI locale for gtc help/output (BCP-47 tag).
      --public-key-file <PATH>  PEM/OpenSSH public key file for this admin.
      --debug-router            Print resolved binary and args to stderr before exec.

gtc remove-admin

Section intitulée « gtc remove-admin »
Remove an admin client certificate identity from a local bundle.
Usage: gtc remove-admin [OPTIONS] <BUNDLE_REF>


Arguments:
  <BUNDLE_REF>  Local bundle directory to update.


Options:
      --cn <CLIENT_CN>     Client certificate Common Name to remove.
  -h, --help               Print help
      --name <ADMIN_NAME>  Admin label to remove.
  -V, --version            Print version
      --locale <BCP47>     UI locale for gtc help/output (BCP-47 tag).
      --debug-router       Print resolved binary and args to stderr before exec.

gtc admin

Section intitulée « gtc admin »
Admin plane helpers.
Usage: gtc admin [OPTIONS] [COMMAND]


Commands:
  access         Show the current admin access plan for a deployed bundle.
  certs          Materialize admin client certificates locally for a deployed bundle.
  token          Materialize the public admin relay token for a deployed bundle.
  health         Probe the deployed public admin relay health endpoint.
  status         Fetch the remote admin runtime status for a deployed bundle.
  list           List bundles visible through the remote admin API.
  admins         List admin client CNs from the remote admin API.
  stop           Request a remote runtime stop through the admin API.
  add-client     Add an allowed admin client CN through the remote admin API.
  remove-client  Remove an allowed admin client CN through the remote admin API.
  tunnel         Open an AWS Session Manager tunnel to the admin API of a deployed bundle.


Options:
  -h, --help            Print help
  -V, --version         Print version
      --locale <BCP47>  UI locale for gtc help/output (BCP-47 tag).
      --debug-router    Print resolved binary and args to stderr before exec.

gtc start

Section intitulée « gtc start »
Start a bundle from local or remote reference.
Usage: gtc start [OPTIONS] [BUNDLE_REF] [args]...


Arguments:
  [args]...


Arguments:
  [BUNDLE_REF]  Bundle path/ref: local path, file://, oci://, repo://, store://


Options:
      --extension-start-handoff <PATH>
          Path to a normalized extension start handoff JSON document.
  -h, --help
          Print help
      --deploy-bundle-source <BUNDLE_SOURCE>
          Override the remote bundle source passed to cloud deployers (for example https://.../bundle.gtbundle).
  -V, --version
          Print version
      --locale <BCP47>
          UI locale for gtc help/output (BCP-47 tag).
      --debug-router
          Print resolved binary and args to stderr before exec.

gtc stop

Section intitulée « gtc stop »
Stop a bundle runtime or destroy a deployed environment.
Usage: gtc stop [OPTIONS] <BUNDLE_REF> [args]...


Arguments:
  [args]...


Arguments:
  <BUNDLE_REF>  Bundle path/ref: local path, file://, oci://, repo://, store://


Options:
  -h, --help            Print help
  -V, --version         Print version
      --locale <BCP47>  UI locale for gtc help/output (BCP-47 tag).
      --debug-router    Print resolved binary and args to stderr before exec.

gtc dev

Section intitulée « gtc dev »
Greentic developer tooling CLI


Usage: greentic-dev [OPTIONS] <COMMAND>


Commands:
  flow       Flow passthrough (greentic-flow)
  pack       Pack passthrough (greentic-pack; pack run uses greentic-runner-cli)
  component  Component passthrough (greentic-component)
  bundle     Bundle pass-through (greentic-bundle)
  runner     Runner pass-through (greentic-runner)
  config     Manage greentic-dev configuration
  coverage   Run coverage checks against coverage-policy.json
  mcp        MCP tooling
  gui        GUI passthrough (greentic-gui)
  secrets    Secrets convenience wrappers
  tools      Install Greentic development/bootstrap tool binaries
  install    Install delegated assets
  release    Generate, publish, and promote Greentic toolchain releases
  cbor       Decode a CBOR file to text
  wizard     Deterministic orchestration for dev workbench workflows


Options:
  -h, --help
          Print help


  -V, --version
          Print version


      --locale <LOCALE>
          Locale (BCP47) used for translated CLI help where supported

gtc op

Section intitulée « gtc op »
Greentic operator tooling


Usage: greentic-operator [OPTIONS] <COMMAND>


Commands:
  demo
  help    Print this message or the help of the given subcommand(s)


Options:
      --locale <LOCALE>  CLI locale (for translated output).
  -h, --help             Print help
  -V, --version          Print version

gtc wizard

Section intitulée « gtc wizard »
Deterministic orchestration for dev workbench workflows


Usage: wizard [OPTIONS] [COMMAND]


Commands:
  validate  Validate a launcher AnswerDocument non-interactively
  apply     Apply a launcher AnswerDocument non-interactively


Options:
      --answers <ANSWERS>
          Answers file (AnswerDocument envelope)


      --frontend <FRONTEND>
          Frontend mode (text/json/adaptive-card)


          [default: json]


      --locale <LOCALE>
          Locale (BCP47), passed to providers and recorded in plan metadata


      --emit-answers <EMIT_ANSWERS>
          Emit a portable AnswerDocument envelope JSON file


      --schema
          Print the current launcher AnswerDocument schema and exit.


          Agentic coding tools such as Codex and Claude should call this first to fetch the exact greentic-dev launcher contract, including the embedded greentic-pack and greentic-bundle answer schemas used for delegation.


      --schema-version <SCHEMA_VERSION>
          Pin schema version for emitted/validated AnswerDocument


      --migrate
          Migrate AnswerDocument to the selected schema version when needed


      --out <OUT>
          Override output directory (default: `.greentic/wizard/<run-id>/`)


      --dry-run
          Preview only (default mode is apply when --dry-run is not set)


      --yes
          Skip interactive confirmation prompt


      --non-interactive
          Allow execution in non-interactive contexts


      --unsafe-commands
          Allow commands outside the default run-command allowlist


      --allow-destructive
          Allow destructive operations (delete/overwrite/move) when requested by a plan step


  -h, --help
          Print help

gtc setup

Section intitulée « gtc setup »
Greentic bundle setup CLI


Usage: greentic-setup [OPTIONS] [BUNDLE] [COMMAND]


Commands:
  bundle  Bundle lifecycle management (advanced)
  help    Print this message or the help of the given subcommand(s)


Arguments:
  [BUNDLE]  Bundle path (.gtbundle file or directory)


Options:
      --dry-run              Dry run - show wizard but don't execute
      --emit-answers <FILE>  Emit answers template to file (combine with --dry-run to only generate)
  -a, --answers <FILE>       Apply answers from file
      --key <KEY>            Encryption/decryption key for answer documents that include secrets
  -t, --tenant <TENANT>      Tenant identifier [default: demo]
      --team <TEAM>          Team identifier
  -e, --env <ENV>            Environment (dev/staging/prod) [default: dev]
      --locale <LOCALE>      UI locale (BCP-47 tag, e.g., en, ja, id)
      --advanced             Advanced mode — show all questions including optional ones
      --ui                   Launch web-based setup UI in browser (enabled by default). Use --no-ui to disable the UI; stdin prompts may still be used
      --no-ui                Disable web UI; stdin prompts may still be used
      --non-interactive      Strict non-interactive mode: no prompts, fail if answers incomplete
  -h, --help                 Print help
  -V, --version              Print version


EXAMPLES:
  Interactive wizard:
    greentic-setup ./my-bundle


  Preview without executing:
    greentic-setup --dry-run ./my-bundle


  Generate answers template:
    greentic-setup --dry-run --emit-answers answers.json ./my-bundle


  Apply answers file:
    greentic-setup --answers answers.json ./my-bundle.gtbundle


  Advanced (bundle subcommands):
    greentic-setup bundle init ./my-bundle
    greentic-setup bundle add pack.gtpack --bundle ./my-bundle
    greentic-setup bundle status --bundle ./my-bundle