Skip to main content
Every youka command accepts the same set of global flags. They control output mode, input handling, waiting behavior, and the target API.

Flags

JSON envelope

With --json, the CLI writes exactly one envelope to stdout and nothing else. Success:
Failure:
Exit codes:
Pipe the envelope through jq for scripting: youka project show $ID --json | jq '.data.state'.

Passing JSON bodies

Any create or update command accepts --body for the full request body. Use it instead of escaping large JSON on the command line.

Waiting for async jobs

--wait polls the created resource on your behalf and returns the final state. Without --wait, commands return as soon as the job is queued.
Pair --wait with --quiet in scripts to suppress the progress bar while still printing the JSON result.

Idempotency

Pass --idempotency-key to make write commands safe to retry. Reusing the same key with the same payload returns the original result instead of creating a duplicate.
Use idempotency keys whenever an agent might retry after a timeout.

Environment variables

What’s next