greentic-component CLI reference

Esta página aún no está disponible en tu idioma.

{/* 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: greentic-component 0.5.2

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

Toolkit for Greentic component developers

Usage: greentic-component [OPTIONS] <COMMAND>

Commands:
  new        Scaffold a new Greentic component project
  wizard     Component wizard helpers
  templates  List available component templates
  doctor     Run component doctor checks
  inspect    Inspect manifests and describe payloads
  info       Describe a compiled component .wasm: exports, imports, capabilities, size
  hash       Recompute manifest hashes
  build      Build component wasm + update config flows
  test       Invoke a component locally with an in-memory state/secrets harness
  flow       Flow utilities (config flow regeneration)
  store      Interact with the component store

Options:
      --locale <LOCALE>
  -h, --help             Print help
  -V, --version          Print version

Subcommands

`greentic-component new`

Scaffold a new Greentic component project

Usage: greentic-component new [OPTIONS] --name <kebab_or_snake>

Options:
      --locale <LOCALE>

      --name <kebab_or_snake>
          Name for the component (kebab-or-snake case)
      --path <dir>
          Path to create the component (defaults to ./<name>)
      --template <id>
          Template identifier to scaffold from [default: rust-wasi-p2-min]
      --org <reverse.dns>
          Reverse DNS-style organisation identifier [default: ai.greentic]
      --version <semver>
          Initial component version [default: 0.1.0]
      --license <id>
          License to embed into generated sources [default: MIT]
      --wit-world <name>
          Exported WIT world name [default: greentic:component/component@0.6.0]
      --operation <name>
          User operations to scaffold into the canonical manifest (repeat or pass comma-separated values)
      --default-operation <name>
          Default user operation written to `default_operation`
      --filesystem-mode <mode>
          Filesystem capability mode written to `capabilities.wasi.filesystem.mode` [default: none]
      --filesystem-mount <name:host_class:guest_path>
          Filesystem mount written to `capabilities.wasi.filesystem.mounts` as `name:host_class:guest_path`
      --http-client
          Enable `capabilities.host.http.client`
      --messaging-inbound
          Enable `capabilities.host.messaging.inbound`
      --messaging-outbound
          Enable `capabilities.host.messaging.outbound`
      --events-inbound
          Enable `capabilities.host.events.inbound`
      --events-outbound
          Enable `capabilities.host.events.outbound`
      --http-server
          Enable `capabilities.host.http.server`
      --state-read
          Enable `capabilities.host.state.read`
      --state-write
          Enable `capabilities.host.state.write`
      --state-delete
          Enable `capabilities.host.state.delete`
      --telemetry-scope <scope>
          Telemetry permission scope for `capabilities.host.telemetry.scope` [default: node]
      --telemetry-span-prefix <prefix>
          Top-level telemetry span prefix written to `telemetry.span_prefix`
      --telemetry-attribute <key=value>
          Top-level telemetry attribute written to `telemetry.attributes` as `key=value`
      --secret-key <key>
          Secret key written to both `secret_requirements` and `capabilities.host.secrets.required`
      --secret-env <env>
          Shared secret env scope for scaffolded secret requirements [default: dev]
      --secret-tenant <tenant>
          Shared secret tenant scope for scaffolded secret requirements [default: default]
      --secret-format <format>
          Shared secret format for scaffolded secret requirements [default: text]
      --config-field <name:type[:required|optional]>
          Config schema field as `name:type[:required|optional]`
      --non-interactive
          Run without prompting for confirmation
      --no-git
          Skip git initialization after scaffolding
      --json
          Emit JSON instead of human-readable output
  -h, --help
          Print help

`greentic-component wizard`

Component wizard helpers

Usage: greentic-component wizard [OPTIONS] [COMMAND]

Commands:
  run
  validate
  apply

Options:
      --locale <LOCALE>


      --mode <MODE>
          [default: create]
          [possible values: create, add-operation, update-operation, build-test, doctor]

      --execution <EXECUTION>
          [default: execute]
          [possible values: dry-run, execute]

      --dry-run


      --validate


      --apply


      --qa-answers <answers.json>


      --answers <answers.json>


      --qa-answers-out <answers.json>


      --emit-answers <answers.json>


      --schema-version <VER>


      --migrate


      --plan-out <plan.json>


      --project-root <PATH>
          [default: .]

      --template <TEMPLATE_ID>


      --full-tests


      --json


      --schema
          Print the current answers.json schema and exit.

          Agentic coding tools such as Codex and Claude should call this first to fetch the current answer schema, fill out answers.json, and replay the wizard non-interactively.

  -h, --help
          Print help

`greentic-component templates`

List available component templates

Usage: greentic-component templates [OPTIONS]

Options:
      --json             Emit JSON instead of a table
      --locale <LOCALE>
  -h, --help             Print help

`greentic-component doctor`

Run component doctor checks

Usage: greentic-component doctor [OPTIONS] <TARGET>

Arguments:
  <TARGET>  Path or identifier resolvable by the loader

Options:
      --locale <LOCALE>
      --manifest <MANIFEST>  Explicit path to component.manifest.json when it is not adjacent to the wasm
      --format <FORMAT>      Output format [default: human] [possible values: human, json]
  -h, --help                 Print help

`greentic-component inspect`

Inspect manifests and describe payloads

Usage: greentic-component inspect [OPTIONS] [TARGET]

Arguments:
  [TARGET]  Path or identifier resolvable by the loader

Options:
      --locale <LOCALE>
      --manifest <MANIFEST>  Explicit path to component.manifest.json when it is not adjacent to the wasm
      --describe <DESCRIBE>  Inspect a pre-generated describe CBOR file (skip WASM execution)
      --json                 Emit structured JSON instead of human output
      --verify               Verify schema_hash values against typed SchemaIR
      --strict               Treat warnings as errors
  -h, --help                 Print help

`greentic-component info`

Describe a compiled component .wasm: exports, imports, capabilities, size

Usage: greentic-component info [OPTIONS] <PATH>

Arguments:
  <PATH>  Path to a compiled component .wasm file

Options:
      --json             Emit the info report as JSON
      --locale <LOCALE>
  -h, --help             Print help

`greentic-component hash`

Recompute manifest hashes

Usage: greentic-component hash [OPTIONS] [MANIFEST]

Arguments:
  [MANIFEST]  Path to component.manifest.json [default: component.manifest.json]

Options:
      --locale <LOCALE>
      --wasm <WASM>      Optional override for the wasm artifact path
  -h, --help             Print help

`greentic-component build`

Build component wasm + update config flows

Usage: greentic-component build [OPTIONS]

Options:
      --locale <LOCALE>
      --manifest <PATH>     Path to component.manifest.json (or directory containing it) [default: component.manifest.json]
      --cargo <PATH>        Path to the cargo binary (fallback: $CARGO, then `cargo` on PATH)
      --no-flow             Skip flow regeneration
      --no-infer-config     Skip config inference; fail if config_schema is missing
      --no-write-schema     Do not write inferred config_schema back to the manifest
      --force-write-schema  Overwrite existing config_schema with inferred schema
      --no-validate         Skip schema validation
      --json                Emit machine-readable JSON summary
      --permissive          Allow empty operation schemas (warnings only)
  -h, --help                Print help

`greentic-component test`

Invoke a component locally with in-memory state/secrets. See docs/component-developer-guide.md for a walkthrough.

Usage: greentic-component test [OPTIONS] --wasm <PATH>

Options:
      --locale <LOCALE>


      --wasm <PATH>
          Path to the component wasm binary

      --world <WORLD>
          Component world to invoke

          [default: greentic:component/component@0.6.0]

      --manifest <PATH>
          Optional manifest path (defaults to component.manifest.json next to the wasm)

      --op <OP>
          Operation to invoke (repeat for multi-step runs)

      --input <PATH>
          Input JSON file path (repeat for multi-step runs)

      --input-json <JSON>
          Inline input JSON string (repeat for multi-step runs)

      --output <PATH>
          Write output JSON to a file

      --config <PATH|JSON>
          Optional component configuration JSON (file path or inline JSON)

      --trace-out <PATH>
          Write trace JSON output (overrides GREENTIC_TRACE_OUT)

      --pretty
          Pretty-print JSON output

      --raw-output
          Emit raw (legacy) output without the JSON envelope

      --dry-run <BOOL>
          Run in dry-run mode (disables HTTP and filesystem writes)

          [default: true]
          [possible values: true, false]

      --allow-http
          Allow HTTP requests (ignored in dry-run)

      --allow-fs-write
          Allow filesystem writes (ignored in dry-run)

      --timeout-ms <MS>
          Timeout in milliseconds

          [default: 2000]

      --max-memory-mb <MB>
          Max memory in megabytes

          [default: 256]

      --state <STATE>
          State backend (only inmem is supported)

          [default: inmem]
          [possible values: inmem]

      --state-dump
          Dump in-memory state after invocation

      --state-set <KEY=BASE64>
          Seed in-memory state as KEY=BASE64 (repeatable)

      --step...
          Repeatable step marker for multi-step runs

      --secrets <PATH>
          Load secrets from a .env style file

      --secrets-json <PATH>
          Load secrets from a JSON map file

      --secret <KEY=VALUE>
          Provide a secret inline as KEY=VALUE (repeatable)

      --env <ENV>
          Environment identifier for the exec context

          [default: dev]

      --tenant <TENANT>
          Tenant identifier for the exec context

          [default: default]

      --team <TEAM>
          Optional team identifier for the exec context

      --user <USER>
          Optional user identifier for the exec context

      --flow <FLOW>
          Optional flow identifier for the exec context

      --node <NODE>
          Optional node identifier for the exec context

      --session <SESSION>
          Optional session identifier for the exec context

      --verbose
          Emit extra diagnostic output (e.g. generated session id)

  -h, --help
          Print help

`greentic-component flow`

Flow utilities (config flow regeneration)

Usage: greentic-component flow [OPTIONS] <COMMAND>

Commands:
  update  Regenerate config flows and embed them into component.manifest.json

Options:
      --locale <LOCALE>
  -h, --help             Print help

`greentic-component store`

Interact with the component store

Usage: greentic-component store [OPTIONS] <COMMAND>

Commands:
  fetch  Fetch a component from a source and write the wasm bytes to disk

Options:
      --locale <LOCALE>
  -h, --help             Print help