Ir al contenido

greentic-flow 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-flow 0.5.7

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.

Flow scaffolding helpers
Usage: greentic-flow [OPTIONS] <COMMAND>
Commands:
new Create a new flow skeleton at the given path
update Update flow metadata in-place without overwriting nodes
add-step Insert a step after an anchor node
update-step Update an existing node (re-run config/default with overrides)
delete-step Delete a node and optionally splice routing
doctor Validate flows
info Describe a .ygtc flow file
doctor-answers Validate answers JSON against a schema
answers Emit JSON schema + example answers for a component operation
component-schema Emit strict JSON schema for a component wizard answer contract
bind-component Attach or repair a sidecar component binding without changing flow nodes
wizard Wizard flow helpers (interactive by default)
help Print this message or the help of the given subcommand(s)
Options:
--permissive Enable permissive schema handling (default: strict)
--format <FORMAT> Output format (human or json) [default: human] [possible values: human, json]
--locale <LOCALE> Diagnostic locale (BCP47)
--backup Backup flow files before overwriting (suffix .bak)
-h, --help Print help
-V, --version Print version
Create a new flow skeleton at the given path
Usage: greentic-flow new [OPTIONS] --flow <FLOW_PATH> --id <FLOW_ID> --type <FLOW_TYPE>
Options:
--flow <FLOW_PATH>
Path to write the new flow
--permissive
Enable permissive schema handling (default: strict)
--format <FORMAT>
Output format (human or json) [default: human] [possible values: human, json]
--id <FLOW_ID>
Flow identifier
--locale <LOCALE>
Diagnostic locale (BCP47)
--type <FLOW_TYPE>
Flow type/kind (e.g., messaging, events, component-config)
--backup
Backup flow files before overwriting (suffix .bak)
--schema-version <SCHEMA_VERSION>
schema_version to write (default 2) [default: 2]
--name <NAME>
Optional flow name/title
--description <DESCRIPTION>
Optional flow description
--force
Overwrite the file if it already exists
-h, --help
Print help
Update flow metadata in-place without overwriting nodes
Usage: greentic-flow update [OPTIONS] --flow <FLOW_PATH>
Options:
--flow <FLOW_PATH>
Path to the flow to update
--permissive
Enable permissive schema handling (default: strict)
--format <FORMAT>
Output format (human or json) [default: human] [possible values: human, json]
--id <FLOW_ID>
New flow ID (only when safe; see rules)
--locale <LOCALE>
Diagnostic locale (BCP47)
--type <FLOW_TYPE>
New flow type/kind (only when flow is empty)
--backup
Backup flow files before overwriting (suffix .bak)
--schema-version <SCHEMA_VERSION>
Optional new schema_version (no auto-bump)
--name <NAME>
Optional flow name/title
--description <DESCRIPTION>
Optional flow description
--tags <TAGS>
Optional comma-separated tags
-h, --help
Print help
Insert a step after an anchor node
Usage: greentic-flow add-step [OPTIONS] --flow <FLOW_PATH> [component_id]
Arguments:
[component_id] Component id to resolve via wizard ops (preferred for new flows)
Options:
--flow <FLOW_PATH>
Path to the flow file to modify
--permissive
Enable permissive schema handling (default: strict)
--after <AFTER>
Optional anchor node id; defaults to entrypoint or first node
--format <FORMAT>
Output format (human or json) [default: human] [possible values: human, json]
--mode <MODE>
How to source the node to insert [default: default] [possible values: default, config]
--backup
Backup flow files before overwriting (suffix .bak)
--pack-alias <PACK_ALIAS>
Optional pack alias for the new node
--wizard-mode <WIZARD_MODE>
Optional wizard mode (default/setup/update/remove) [possible values: default, setup, update, remove]
--operation <OPERATION>
Optional operation for the new node
--payload <PAYLOAD>
Payload JSON for the new node (default mode) [default: {}]
--routing-out
Routing shorthand: make the new node terminal (out)
--routing-reply
Routing shorthand: reply to origin
--routing-next <ROUTING_NEXT>
Route to a specific node id
--routing-multi-to <ROUTING_MULTI_TO>
Route to multiple node ids (comma-separated)
--routing-json <ROUTING_JSON>
Explicit routing JSON file (escape hatch)
--routing-to-anchor
Explicitly thread to the anchor’s existing targets (default if no routing flag is given)
--config-flow <CONFIG_FLOW>
Config flow file to execute (config mode)
--answers <ANSWERS>
Answers JSON for config mode
--answers-file <ANSWERS_FILE>
Answers file (JSON) for config mode
--answers-dir <ANSWERS_DIR>
Directory for wizard answers artefacts
--overwrite-answers
Overwrite existing answers artefacts
--reask
Force re-asking wizard questions even if answers exist
--locale <LOCALE>
Locale (BCP47) for wizard prompts
--interactive
Allow interactive QA prompts (wizard mode only)
--allow-cycles
Allow cycles/back-edges during insertion
--dry-run
Show the updated flow without writing it
--validate-only
Validate only without writing output
--manifest <MANIFESTS>
Optional component manifest paths for catalogue validation or config flow discovery
--node-id <NODE_ID>
Optional node ID override
--component <COMPONENT_REF>
Remote component reference (oci://, repo://, store://, etc.) for sidecar binding
--local-wasm <LOCAL_WASM>
Local wasm path for sidecar binding (relative to the flow file)
--distributor-url <DISTRIBUTOR_URL>
Distributor URL for component-id resolution
--auth-token <AUTH_TOKEN>
Distributor auth token (optional)
--tenant <TENANT>
Tenant id for component-id resolution
--env <ENV>
Environment id for component-id resolution
--pack <PACK>
Pack id for component-id resolution
--component-version <COMPONENT_VERSION>
Component version for component-id resolution
--abi-version <ABI_VERSION>
ABI version override for wizard ops
--resolver <RESOLVER>
Resolver override (fixture://...) for tests/CI
--pin
Pin the component (resolve tag to digest or hash local wasm)
--allow-contract-change
Allow contract drift when describe_hash changes
-h, --help
Print help
Update an existing node (re-run config/default with overrides)
Usage: greentic-flow update-step [OPTIONS] --flow <FLOW_PATH> [component_id]
Arguments:
[component_id] Component id to resolve via wizard ops (preferred for new flows)
Options:
--flow <FLOW_PATH>
Flow file to update
--permissive
Enable permissive schema handling (default: strict)
--format <FORMAT>
Output format (human or json) [default: human] [possible values: human, json]
--step <STEP>
Node id to update (optional when component metadata exists)
--mode <MODE>
Mode: default (default) or config [default: default] [possible values: config, default]
--backup
Backup flow files before overwriting (suffix .bak)
--wizard-mode <WIZARD_MODE>
Optional wizard mode (default/setup/update/remove) [possible values: default, setup, update, remove]
--operation <OPERATION>
Optional new operation name (defaults to existing op key)
--routing-out
Routing shorthand: make the node terminal (out)
--routing-reply
Routing shorthand: reply to origin
--routing-next <ROUTING_NEXT>
Route to a specific node id
--routing-multi-to <ROUTING_MULTI_TO>
Route to multiple node ids (comma-separated)
--routing-json <ROUTING_JSON>
Explicit routing JSON file (escape hatch)
--answers <ANSWERS>
Answers JSON/YAML string to merge with existing payload
--answers-file <ANSWERS_FILE>
Answers file (JSON/YAML) to merge with existing payload
--answers-dir <ANSWERS_DIR>
Directory for wizard answers artefacts
--overwrite-answers
Overwrite existing answers artefacts
--reask
Force re-asking wizard questions even if answers exist
--locale <LOCALE>
Locale (BCP47) for wizard prompts
--non-interactive
Non-interactive mode (merge answers/prefill; fail if required missing)
--interactive
Allow interactive QA prompts (wizard mode only)
--component <COMPONENT>
Optional component reference (oci://, repo://, store://)
--local-wasm <LOCAL_WASM>
Local wasm path for wizard ops (relative to the flow file)
--distributor-url <DISTRIBUTOR_URL>
Distributor URL for component-id resolution
--auth-token <AUTH_TOKEN>
Distributor auth token (optional)
--tenant <TENANT>
Tenant id for component-id resolution
--env <ENV>
Environment id for component-id resolution
--pack <PACK>
Pack id for component-id resolution
--component-version <COMPONENT_VERSION>
Component version for component-id resolution
--abi-version <ABI_VERSION>
ABI version override for wizard ops
--resolver <RESOLVER>
Resolver override (fixture://...) for tests/CI
--dry-run
Show the updated flow without writing it
--allow-contract-change
Allow contract drift when describe_hash changes
-h, --help
Print help
Delete a node and optionally splice routing
Usage: greentic-flow delete-step [OPTIONS] --flow <FLOW_PATH> [component_id]
Arguments:
[component_id] Component id to resolve via wizard ops (preferred for new flows)
Options:
--flow <FLOW_PATH>
Flow file to update
--permissive
Enable permissive schema handling (default: strict)
--format <FORMAT>
Output format (human or json) [default: human] [possible values: human, json]
--step <STEP>
Node id to delete (optional when component metadata exists)
--wizard-mode <WIZARD_MODE>
Optional wizard mode (default/setup/update/remove) [possible values: default, setup, update, remove]
--answers <ANSWERS>
Answers JSON/YAML string to merge with wizard prompts
--backup
Backup flow files before overwriting (suffix .bak)
--answers-file <ANSWERS_FILE>
Answers file (JSON/YAML)
--answers-dir <ANSWERS_DIR>
Directory for wizard answers artefacts
--overwrite-answers
Overwrite existing answers artefacts
--reask
Force re-asking wizard questions even if answers exist
--locale <LOCALE>
Locale (BCP47) for wizard prompts
--interactive
Allow interactive QA prompts (wizard mode only)
--component <COMPONENT>
Optional component reference (oci://, repo://, store://)
--local-wasm <LOCAL_WASM>
Local wasm path for wizard ops (relative to the flow file)
--distributor-url <DISTRIBUTOR_URL>
Distributor URL for component-id resolution
--auth-token <AUTH_TOKEN>
Distributor auth token (optional)
--tenant <TENANT>
Tenant id for component-id resolution
--env <ENV>
Environment id for component-id resolution
--pack <PACK>
Pack id for component-id resolution
--component-version <COMPONENT_VERSION>
Component version for component-id resolution
--abi-version <ABI_VERSION>
ABI version override for wizard ops
--resolver <RESOLVER>
Resolver override (fixture://...) for tests/CI
--strategy <STRATEGY>
Strategy: splice (default) or remove-only [default: splice] [possible values: splice, remove-only]
--if-multiple-predecessors <MULTI_PRED>
Behaviour when multiple predecessors are present [default: error] [possible values: error, splice-all]
--assume-yes
Skip confirmation prompt
--write
Write back to the flow file instead of stdout
-h, --help
Print help
Validate flows
Usage: greentic-flow doctor [OPTIONS] [TARGETS]...
Arguments:
[TARGETS]... Flow files or directories to lint
Options:
--permissive Enable permissive schema handling (default: strict)
--schema <SCHEMA> Path to the flow schema JSON file
--format <FORMAT> Output format (human or json) [default: human] [possible values: human, json]
--registry <REGISTRY> Optional adapter catalogue used for adapter_resolvable linting
--json Emit a machine-readable JSON payload describing the lint result for a single flow
--locale <LOCALE> Diagnostic locale (BCP47)
--backup Backup flow files before overwriting (suffix .bak)
--stdin Read flow YAML from stdin (requires --json)
--online Re-resolve components and verify contract drift (networked)
-h, --help Print help
Describe a .ygtc flow file
Usage: greentic-flow info [OPTIONS] <PATH>
Arguments:
<PATH> Path to a .ygtc file
Options:
--json Emit the report as JSON
--permissive Enable permissive schema handling (default: strict)
--format <FORMAT> Output format (human or json) [default: human] [possible values: human, json]
-h, --help Print help
--locale <LOCALE> Diagnostic locale (BCP47)
--backup Backup flow files before overwriting (suffix .bak)
Validate answers JSON against a schema
Usage: greentic-flow doctor-answers [OPTIONS] --schema <SCHEMA> --answers <ANSWERS>
Options:
--permissive Enable permissive schema handling (default: strict)
--schema <SCHEMA> Path to the answers JSON schema
--answers <ANSWERS> Path to the answers JSON
--format <FORMAT> Output format (human or json) [default: human] [possible values: human, json]
--json Emit JSON output
--locale <LOCALE> Diagnostic locale (BCP47)
--backup Backup flow files before overwriting (suffix .bak)
-h, --help Print help
Emit JSON schema + example answers for a component operation
Usage: greentic-flow answers [OPTIONS] --component <COMPONENT> --operation <OPERATION> --name <NAME>
Options:
--component <COMPONENT> Component reference (oci://, repo://, store://) or local path
--permissive Enable permissive schema handling (default: strict)
--format <FORMAT> Output format (human or json) [default: human] [possible values: human, json]
--operation <OPERATION> Component operation (used to select dev_flow graph)
--locale <LOCALE> Diagnostic locale (BCP47)
--mode <MODE> Which dev_flow to use for questions (default uses --operation, config uses "custom") [default: default] [possible values: default, config]
--backup Backup flow files before overwriting (suffix .bak)
--name <NAME> Output file prefix
--out-dir <OUT_DIR> Output directory (defaults to current directory)
-h, --help Print help
Emit strict JSON schema for a component wizard answer contract.
This is designed for agentic and automated tooling: fetch the per-component schema first, collect valid answers for the selected mode, and then embed those answers into a flow wizard plan.
Usage: greentic-flow component-schema [OPTIONS] <COMPONENT>
Arguments:
<COMPONENT>
Component reference (oci://, repo://, store://) or local wasm path
Options:
--mode <MODE>
Wizard mode / answer contract to emit.
Use this to fetch the exact answer schema for the component's default, setup, update, or remove flow before composing wizard plans.
[default: default]
[possible values: default, setup, update, remove]
--permissive
Enable permissive schema handling (default: strict)
--format <FORMAT>
Output format (human or json)
[default: human]
[possible values: human, json]
--resolver <RESOLVER>
Resolver override (fixture://...) for tests/CI
--locale <LOCALE>
Locale (BCP47) for question descriptions
--backup
Backup flow files before overwriting (suffix .bak)
--out <OUT>
Optional output path for the emitted schema.
If omitted, the schema is written to stdout so other tools can capture it directly.
-h, --help
Print help
Attach or repair a sidecar component binding without changing flow nodes
Usage: greentic-flow bind-component [OPTIONS] --flow <FLOW_PATH> --step <STEP>
Options:
--flow <FLOW_PATH> Path to the flow file to modify
--permissive Enable permissive schema handling (default: strict)
--format <FORMAT> Output format (human or json) [default: human] [possible values: human, json]
--step <STEP> Node id to bind
--component <COMPONENT_REF> Remote component reference (oci://, repo://, store://, etc.)
--locale <LOCALE> Diagnostic locale (BCP47)
--backup Backup flow files before overwriting (suffix .bak)
--local-wasm <LOCAL_WASM> Local wasm path (relative to the flow file)
--pin Pin the component (resolve tag to digest or hash local wasm)
--write Write back to the sidecar
-h, --help Print help
Wizard flow helpers (interactive by default)
Usage: greentic-flow wizard [OPTIONS] [PACK]
Arguments:
[PACK]
Pack root directory
Options:
--answers <ANSWERS_PATH>
Load or save a declarative wizard action plan.
Agentic coding tools such as Codex and Claude can fetch the strict plan schema with `--schema`, fill out the plan JSON at this path, and rerun the wizard non-interactively with `--answers`.
--permissive
Enable permissive schema handling (default: strict)
--format <FORMAT>
Output format (human or json)
[default: human]
[possible values: human, json]
--schema
Write a strict wizard action-plan schema to stdout.
Agentic coding tools such as Codex and Claude should call this first to fetch the current plan schema, compose a valid plan JSON, and then rerun the wizard with `--answers` to apply it non-interactively.
--dry-run
Validate and run doctor, but do not persist flow mutations
--locale <LOCALE>
Diagnostic locale (BCP47)
--backup
Backup flow files before overwriting (suffix .bak)
-h, --help
Print help