oz0 client generate
For: Operators and developers looking up a command.
Write typed wrappers of a tenant's agents and flows for the Python, TypeScript or Go client SDK: a type per object of their input and output schemas, and per agent and flow a method that starts it with its input typed and one that runs it and returns its answer typed.
They come from the tenant's OpenAPI document, GET /v1/openapi.json, which the command reads from the edge: with an API key from $OZ0_API_KEY (--api-key-env) when --url or $OZ0_URL names the edge, and with the CLI context's operator certificate otherwise. --from reads a saved document instead.
Without --out the code goes to stdout. With --out DIR it goes to DIR/agents.py, agents.ts or agents.go; a file there that was generated from the same catalog (its ETag), by the same version of the generator, for the same tenant and Go package, is left as it is unless --force, so an app's CI can run this on every build and commit what changed.
--plugin limits it to one plugin's agents and flows (GET /v1/openapi.json?plugin=), for a tenant whose whole document is large: with thousands of agents it is megabytes.
Usage
oz0 client generate [flags]
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
--api-key-env | string | OZ0_API_KEY | the environment variable that holds the API key, with --url |
--ca-file | string | $OZ0_CA_FILE | the cluster's CA certificate, with --url |
--force | bool | write the file even when the catalog has not changed since it was generated | |
--from | string | read the OpenAPI document from this file ("-" for stdin) instead of the edge | |
--lang | string | the SDK's language: python, ts or go | |
--out | string | a directory to write agents.py, agents.ts or agents.go to, instead of stdout | |
--package | string | the --out directory's name, or agents | the Go package's name |
--plugin | string | only this plugin's agents and flows | |
--tenant | string | $OZ0_TENANT, else the API key's, or the document's | the tenant |
--url | string | $OZ0_URL, or the CLI context's | the edge's runtime API, such as https://edge.example.com:7443 |
Inherited flags
| Flag | Type | Default | Description |
|---|---|---|---|
--context | string | $OZ0_CONTEXT or <config dir>/orchestrator-zero/context.json | CLI context file written by server init |
--log-level | string | info | log level: debug, info, warn or error |
See all oz0 commands and the global flags.