Skip to main content

Command Reference

Complete reference for every yr command. All commands support --output json for machine-readable output and --context <name> to override the active auth context.

Commands that delete resources prompt for confirmation interactively; pass -y / --yes to skip the prompt in scripts.

auth​

Manage authentication contexts.

CommandDescription
yr auth loginAuthenticate via OAuth (default) or PAT (--use-pat / --pat <token>)
yr auth statusShow the current context (server, user, org, token type, expiry). Warns when the token expires within 30 minutes
yr auth listList all saved contexts
yr auth switch <name>Set a context as current
yr auth rename <old> <new>Rename a context
yr auth remove <name>Remove a context
yr auth refreshShow how to refresh the current token
yr auth revokeRevoke a PAT server-side and remove the context

template​

Manage workflow templates in the org catalog.

CommandDescription
yr template listList templates. Filter with --provenance <value> or --tag <value>
yr template get <id>Show template details
yr template delete <id>Delete a template
note

Templates are created automatically when workflow artifacts are scanned from a registry. Use yr artifact build --push and yr registry scan to add templates.

installation​

Manage workflow installations (installed instances of templates). Alias: inst.

CommandDescription
yr installation listList installations. Filter with --space <id> or --status <value>
yr installation get <id>Show installation details and recent runs
yr installation createCreate from a template. --name, --space, --template required; --bind key=id for connector bindings
yr installation update <id>Update. --name, --status, --inference-backend
yr installation delete <id>Delete an installation
yr installation trigger <id>Trigger a run. --payload '{"key":"val"}' or --payload @file.json; --wait streams the journal via SSE until the run completes; --timeout sets the wait deadline

run​

Inspect and interact with workflow runs.

CommandDescription
yr run get <id>Show run details (status, timing, template)
yr run inspect <id>Combined view: run details + journal + outputs
yr run journal <id>Show the run journal. --wait streams events live via SSE (reconnects on drop); --timeout sets the stream deadline; --verbose / -v shows full untruncated fields
yr run resume <id>Resume a paused run. --event <type> required; --payload '{"key":"val"}' or --payload @file.json
yr run outputs <id>List run output files. --download fetches them; --out <dir> sets the download directory

artifact​

Build and inspect workflow OCI artifacts. See OCI Artifacts for the artifact spec.

CommandDescription
yr artifact build [dir]Build a workflow artifact from a Dockerfile. Validates CWL structure and required labels; warns when the image platform isn't linux/amd64. --registry <id> selects the target registry (auto-selected if only one exists); --push pushes after build and triggers a registry scan
yr artifact inspect <ref>Pull an artifact by reference and display its metadata (name, slug, version, category, description)
note

yr artifact build requires Docker to be installed and running.

integration​

Manage org integrations (authenticated connector instances).

CommandDescription
yr integration listList integrations
yr integration get <id>Show integration details
yr integration createCreate an integration. --name, --connector, --auth-method, --account-label required
yr integration update <id>Update. --name, --account-label, --status
yr integration delete <id>Delete an integration

registry​

Manage OCI registries for workflow artifact discovery.

CommandDescription
yr registry listList registries
yr registry get <id>Show registry details
yr registry createCreate a registry. --name, --url required; optional --credential
yr registry update <id>Update. --name, --url, --credential
yr registry delete <id>Delete a registry
yr registry test <id>Test registry connectivity
yr registry scan <id>Trigger a scan for workflow artifacts. --wait blocks until new templates are discovered; --timeout sets the wait deadline (default 2m)

inference-backend​

Manage inference backends for yr:Agent workflow steps. Alias: ib.

CommandDescription
yr inference-backend listList configured and custom backends
yr inference-backend get <id>Show custom backend details
yr inference-backend createCreate a backend. --name, --provider, --base-url, --model, --api-key required
yr inference-backend update <id>Update. --name, --provider, --base-url, --model, --api-key
yr inference-backend delete <id>Delete a custom backend
yr inference-backend test <id>Test backend connectivity

webhook​

Manage inbound webhook endpoints.

CommandDescription
yr webhook listList webhook endpoints
yr webhook get <id>Show webhook details
yr webhook createCreate a webhook. --label required; optional --handler, --config, --workflow
yr webhook update <id>Update. --label, --config, --enabled
yr webhook delete <id>Delete a webhook

site​

Manage organization sites (static hosting for workflow outputs).

CommandDescription
yr site listList sites
yr site get <id>Show site details
yr site createCreate a site. --name, --slug required
yr site update <id>Update. --name, --slug
yr site delete <id>Delete a site
yr site set-access <id>Set access tier. --tier required (public, org_authenticated, password_protected); --password for password-protected. Visitors access password-protected sites via ?p=<password> in the URL
yr site publish <id>Publish run outputs to a site. --run <run-id> required
yr site open <id>Open the site URL in your browser. Auto-detects local.yardrail.site for local contexts; --domain overrides
yr site version list <site-id>List site versions
yr site version restore <site-id> <version-id>Restore a previous version

space​

Manage organization spaces.

CommandDescription
yr space listList spaces
yr space get <id>Show space details and sharing permissions
yr space createCreate a space. --name, --scope required; optional --description, --team
yr space update <id>Update. --name, --description
yr space delete <id>Delete a space
yr space share <id>Share with a team (--team) or user (--user). --level required
yr space revoke <id> <principal-id>Revoke a space share

team​

Manage organization teams.

CommandDescription
yr team listList teams
yr team get <id>Show team details
yr team createCreate a team. --name required
yr team update <id>Rename. --name required
yr team delete <id>Delete a team
yr team member add <team-id>Add a member. --user, --role required
yr team member set-role <team-id> <user-id>Change a member's role. --role required
yr team member remove <team-id> <user-id>Remove a member

user​

Manage organization users.

CommandDescription
yr user listList org users
yr user get <id>Show user details
yr user set-role <id>Change org role. --role required (member, org_admin)
yr user remove <id>Remove user from the org

invite​

Manage invite links.

CommandDescription
yr invite listList invites
yr invite createCreate an invite link. Optional --role
yr invite revoke <id>Revoke an invite

email-provider​

Manage outgoing email providers. Alias: ep.

CommandDescription
yr email-provider listList email providers
yr email-provider createCreate a provider. --name, --type required; --settings '{"key":"val"}'
yr email-provider update <id>Update. --name, --type, --settings
yr email-provider delete <id>Delete a provider

email-identity​

Manage email sender identities. Alias: ei.

CommandDescription
yr email-identity listList identities
yr email-identity createCreate an identity. --provider, --name, --from, --reply-to required
yr email-identity update <id>Update. --name, --from, --reply-to
yr email-identity delete <id>Delete an identity
yr email-identity test <id>Send a test email. --to <address> required

config​

CommandDescription
yr config getShow platform configuration (billing, email, depot URL, public base URL)

version​

yr version

Print the CLI version.