kindgi agents

`kindgi agents`

Synopsis

kindgi agents <command>

Signature

Manage agent registrations and which version runs where.

Commands

Command	Description
`kindgi agents list`	List registered agents (the latest version of each).
`kindgi agents get`	Fetch a registered agent: its latest version, or the version given.
`kindgi agents publish`	Register an agent definition.
`kindgi agents unregister`	Unregister a specific agent version: runs stop using it.
`kindgi agents owner`	Show the agent's owner, or set it: the person its corrections go to when they need the owner.
`kindgi agents versions`	List the registered versions of an agent.
`kindgi agents pinned`	Show the version a run of this agent would use for a project and segment path, and why: a pinned version (with its scope) or the latest.
`kindgi agents pinned-versions`	List every scope with a version of this agent pinned.
`kindgi agents pin`	Pin a version for a scope: its runs that don't name a version use it, from the next run.
`kindgi agents release-gate`	Show the release gate that pinning a version of this agent for a scope is checked against (the most specific scope with one), or null.
`kindgi agents unpin`	Remove a scope's own pin: its runs use the next scope up (or the latest when nothing is pinned).
`kindgi agents pin-history`	The history of what was pinned or unpinned.

See also

`kindgi agents list`

Synopsis

kindgi agents list [--name=<prefix>] [--include-retired] [--limit=<n>] [--cursor=<c>]

Signature

List registered agents (the latest version of each).

Options

Option	Default	Description
`--cursor <value>`	none	Resume after this cursor, from the previous page's `nextCursor`.
`--include-retired`	off	Include retired agents (every version unregistered), each as its highest version with `unregisteredAt`.
`--limit <value>`	`25` (at most `100`)	The most to return (default 25, at most 100).
`--name <value>`	none	Only agents whose id starts with this.

Every command also takes the global flags.

Examples

List the registered agents.

kindgi agents list

List agents whose id starts with a prefix, including retired ones.

kindgi agents list --name=acme-ops. --include-retired

See also

`kindgi agents get`

Synopsis

kindgi agents get <agent-id> [<version>]

Signature

Fetch a registered agent: its latest version, or the version given.

Options

Every command also takes the global flags.

Examples

Show an agent's latest version.

kindgi agents get acme-ops.reply-drafter

Show one specific version.

kindgi agents get acme-ops.reply-drafter 1.2.0

See also

`kindgi agents publish`

Synopsis

kindgi agents publish --spec=<json-or-@file> [--project=<project-id>]

Signature

Options

Option	Default	Description
`--project <value>`	the workspace's default project	The project to register the agent in, by id (default: the workspace's default project).
`--spec <value>`	required	The agent definition as JSON, or `@<file>` to read it from a file. Required.

Every command also takes the global flags.

Examples

kindgi agents publish --spec=@agent.json

kindgi agents publish --spec=@agent.json --project=<project-id>

See also

`kindgi agents unregister`

Synopsis

kindgi agents unregister <agent-id> <version>

Signature

Unregister a specific agent version: runs stop using it.

Options

Every command also takes the global flags.

Examples

Unregister one version of an agent, so runs stop using it.

kindgi agents unregister acme-ops.reply-drafter 1.2.0

From Deploy your agent to Kindgi Cloud:

pnpm exec kindgi agents unregister acme-desk.reply-drafter <old version>

See also

`kindgi agents owner`

Synopsis

kindgi agents owner <agent-id> [--set=<user-id>]

Signature

Show the agent's owner, or set it: the person its corrections go to when they need the owner.

Options

Option	Default	Description
`--set <value>`	none (shows the owner)	Make this person the owner, replacing the one before. Needs admin on the agent.

Every command also takes the global flags.

Examples

Show the agent's owner.

kindgi agents owner acme-ops.reply-drafter

Make a person the owner, replacing the one before.

kindgi agents owner acme-ops.reply-drafter --set=<user-id>

See also

`kindgi agents versions`

Synopsis

kindgi agents versions <agent-id> [--include-unregistered] [--limit=<n>] [--cursor=<c>]

Signature

List the registered versions of an agent.

Options

Option	Default	Description
`--cursor <value>`	none	Resume after this cursor, from the previous page's `nextCursor`.
`--include-unregistered`	off	Include unregistered versions (each with `unregisteredAt`), a retired agent's too.
`--limit <value>`	`25` (at most `100`)	The most to return (default 25, at most 100).

Every command also takes the global flags.

Examples

List an agent's registered versions.

kindgi agents versions acme-ops.reply-drafter

Include unregistered versions too.

kindgi agents versions acme-ops.reply-drafter --include-unregistered

See also

`kindgi agents pinned`

Synopsis

kindgi agents pinned <agent-id> [--project=<project-id> [--segment=<key:value>]…]

Signature

Show the version a run of this agent would use for a project and segment path, and why: a pinned version (with its scope) or the latest.

Options

Option	Default	Description
`--project <value>`	none	The run's project, by id.
`--segment <value>`	none	One step of the segment path, `key:value` (e.g. `company:acme`); repeat it in order, coarse to fine. Needs `--project`. Repeatable.

Every command also takes the global flags.

Examples

From Fix what the experts corrected:

pnpm exec kindgi agents pinned acme-store.refunds --project=<project-id>

From Release an agent version:

pnpm exec kindgi agents pinned acme.order-desk --project=<project-id> --segment=company:acme

See also

`kindgi agents pinned-versions`

Synopsis

kindgi agents pinned-versions <agent-id>

Signature

List every scope with a version of this agent pinned.

Options

Every command also takes the global flags.

Examples

List every scope with a pinned version of the agent.

kindgi agents pinned-versions acme.order-desk

See also

`kindgi agents pin`

Synopsis

kindgi agents pin <agent-id> <version> (--tenant | --org=<org-id> | --project=<project-id> [--segment=<key:value>]…) [--test-run=<test-run-id>] [--reason=<text>] [--stop-following-latest] [--check] [--wait[=<duration>]]

Signature

Pin a version for a scope: its runs that don't name a version use it, from the next run. Open conversations keep their version. It prints the pin's answer: the pin under pin, the test runs that check it, and the corrections a reused run marked fixed or reopened. With a release gate for the scope, the run on the test cases named by --test-run is checked first: the pin's status is pinned, or pending-approval (a reviewer approves it); a refusal lists every check. A pin that would take a project that follows Latest off it is refused (409 pin-stops-latest) unless --stop-following-latest. --check asks what the release gate would say, changing nothing. Under kindgi dev, where a pin writes the version into the pack's files, it says on stderr which of the files it writes over that git hasn't committed, or that the pack isn't in git, from the pin check it asks first. Exits 3 when the answer is no: the gate refuses the version, or it waits for an approval (--wait waits for the decision).

Options

Option	Default	Description
`--check`	off	What the release gate would say: would-pin, needs-approval or gate-failed. Changes nothing. Exits 3 unless it would pin.
`--idempotency-key <value>`	none	A retry with the same key returns the first call's result.
`--org <value>`	required: one of `--tenant`, `--org`, `--project`	An org, by id.
`--project <value>`	required: one of `--tenant`, `--org`, `--project`	A project, by id; with `--segment`, a segment in it.
`--reason <value>`	none	Why, kept on the record.
`--segment <value>`	none	One step of the segment path, `key:value` (e.g. `company:acme`); repeat it in order, coarse to fine. Needs `--project`. Repeatable.
`--stop-following-latest`	off	Pin even when it takes a project that follows Latest off it: that project then runs the pinned version, and no longer takes each new Latest. Without it, such a pin is refused (`409 pin-stops-latest`).
`--tenant`	required: one of `--tenant`, `--org`, `--project`	The whole workspace (scope `tenant`).
`--test-run <value>`	none	The run on the test cases the release gate checks, kept on the record.
`--wait <value>`	off; a bare `--wait` waits at most `1h`	When a version waits for an approval, wait until a reviewer decides: at most the duration given (90s, 30m, 2h), 1h when none is. Exits 0 once it is pinned, and 3 when it is rejected, its approval expires, it is superseded or the wait runs out, and 1 when 3 reads of the pin in a row fail. An approval stays open after the wait.

Every command also takes the global flags.

Examples

From Fix what the experts corrected:

pnpm exec kindgi agents pin acme-store.refunds 1.0.4 --project=<project-id> --check
pnpm exec kindgi agents pin acme-store.refunds 1.0.4 --project=<project-id> \

See also

`kindgi agents release-gate`

Synopsis

kindgi agents release-gate <agent-id> (--tenant | --org=<org-id> | --project=<project-id> [--segment=<key:value>]…)

Signature

Show the release gate that pinning a version of this agent for a scope is checked against (the most specific scope with one), or null.

Options

Option	Default	Description
`--org <value>`	required: one of `--tenant`, `--org`, `--project`	An org, by id.
`--project <value>`	required: one of `--tenant`, `--org`, `--project`	A project, by id; with `--segment`, a segment in it.
`--segment <value>`	none	One step of the segment path, `key:value` (e.g. `company:acme`); repeat it in order, coarse to fine. Needs `--project`. Repeatable.
`--tenant`	required: one of `--tenant`, `--org`, `--project`	The whole workspace (scope `tenant`).

Every command also takes the global flags.

Examples

Show the release gate for the whole workspace.

kindgi agents release-gate acme.order-desk --tenant

Show the release gate for a segment of a project.

kindgi agents release-gate acme.order-desk --project=<project-id> --segment=company:acme

See also

`kindgi agents unpin`

Synopsis

kindgi agents unpin <agent-id> (--tenant | --org=<org-id> | --project=<project-id> [--segment=<key:value>]…) [--reason=<text>]

Signature

Remove a scope's own pin: its runs use the next scope up (or the latest when nothing is pinned).

Options

Option	Default	Description
`--idempotency-key <value>`	none	A retry with the same key returns the first call's result.
`--org <value>`	required: one of `--tenant`, `--org`, `--project`	An org, by id.
`--project <value>`	required: one of `--tenant`, `--org`, `--project`	A project, by id; with `--segment`, a segment in it.
`--reason <value>`	none	Why, kept on the record.
`--segment <value>`	none	One step of the segment path, `key:value` (e.g. `company:acme`); repeat it in order, coarse to fine. Needs `--project`. Repeatable.
`--tenant`	required: one of `--tenant`, `--org`, `--project`	The whole workspace (scope `tenant`).

Every command also takes the global flags.

Examples

From Release an agent version:

pnpm exec kindgi agents unpin acme.order-desk --tenant --reason="Back to the latest"

See also

`kindgi agents pin-history`

Synopsis

kindgi agents pin-history <command>

Signature

The history of what was pinned or unpinned.

Commands

Command	Description
`kindgi agents pin-history list`	List an agent's pin history, newest first: requests to pin a version, and unpins; name a scope for only its history.
`kindgi agents pin-history get`	Fetch one entry of an agent's pin history.

See also

`kindgi agents pin-history list`

Synopsis

kindgi agents pin-history list <agent-id> [(--tenant | --org=<org-id> | --project=<project-id> [--segment=<key:value>]…)] [--limit=<n>] [--cursor=<c>]

Signature

List an agent's pin history, newest first: requests to pin a version, and unpins; name a scope for only its history.

Options

Option	Default	Description
`--cursor <value>`	none	Resume after this cursor, from the previous page's `nextCursor`.
`--limit <value>`	`25` (at most `100`)	The most to return (default 25, at most 100).
`--org <value>`	none (no scope given: the history of every scope)	An org, by id.
`--project <value>`	none (no scope given: the history of every scope)	A project, by id; with `--segment`, a segment in it.
`--segment <value>`	none	One step of the segment path, `key:value` (e.g. `company:acme`); repeat it in order, coarse to fine. Needs `--project`. Repeatable.
`--tenant`	none (no scope given: the history of every scope)	The whole workspace (scope `tenant`).

Every command also takes the global flags.

Examples

From Pinned versions reference:

pnpm exec kindgi agents pin-history list acme.order-desk --table

See also

`kindgi agents pin-history get`

Synopsis

kindgi agents pin-history get <agent-id> <change-id>

Signature

Fetch one entry of an agent's pin history.

Options

Every command also takes the global flags.

Examples

Show one entry of an agent's pin history.

kindgi agents pin-history get acme.order-desk <change-id>

See also