Skip to content

kindgi corrector-groups

View as Markdown

Synopsis

Terminal window
kindgi corrector-groups <command>
Signature

Manage corrector groups, the weighted kinds of person who corrects (list / add / set / remove).

Commands

Command Description
kindgi corrector-groups list List corrector groups, newest first.
kindgi corrector-groups add Add a corrector group: a named kind of person who corrects with a weight, for the tenant, a project, or an agent.
kindgi corrector-groups set Change a corrector group's weight, description, or who may assert it.
kindgi corrector-groups remove Retire a corrector group: no new corrections may name it; existing ones keep it.

See also

Synopsis

Terminal window
kindgi corrector-groups list [--tenant | --project=<id> | --agent=<id> --project=<id>] [--limit=<n>] [--cursor=<c>]
Signature

List corrector groups, newest first.

Options

Option Default Description
--agent <value> none One agent, by id. Needs --project.
--cursor <value> none Resume after this cursor, from the previous page's nextCursor.
--limit <value> 25 (at most 100) The most groups to return (default 25, at most 100).
--project <value> none A project, by id. With --agent, the project the agent is in.
--tenant off (with no scope flag, no scope filter is sent) The whole tenant.

Every command also takes the global flags.

Examples

List the corrector groups of the whole tenant.

Terminal window
kindgi corrector-groups list --tenant

List the groups of one agent in a project.

Terminal window
kindgi corrector-groups list --agent=acme-ops.reply-drafter --project=<project-id>

See also

Synopsis

Terminal window
kindgi corrector-groups add --name=<name> --weight=<w> (--tenant | --project=<id> | --agent=<id> --project=<id>) [--description=<text>] [--min-reviewer-role=standard|senior|admin] [--principal-kind=user|service ...] [--principal-id=<id> ...]
Signature

Add a corrector group: a named kind of person who corrects with a weight, for the tenant, a project, or an agent. The restriction flags limit who may assert it; without them, anyone who may correct the run may.

Options

Option Default Description
--agent <value> none One agent, by id. Needs --project.
--description <value> none What the group is for.
--min-reviewer-role <value> none (anyone who may correct the run may assert) Only reviewers of this role or above may assert the group: standard, senior, admin.
--name <value> required The group name, e.g. expert. Required.
--principal-id <value> none (no restriction) Only this user or token id may assert the group. Repeat the flag for several. Repeatable.
--principal-kind <value> none (no restriction) Only people (user) or service tokens (service) may assert the group. Repeat the flag for both. Repeatable.
--project <value> none A project, by id. With --agent, the project the agent is in.
--tenant off (a scope is required: --tenant, --project, or --agent with --project) The whole tenant.
--weight <value> required How much a correction of this group counts, a number of 0 or more. Required.

Every command also takes the global flags.

Examples

From Correct a run's output:

Terminal window
pnpm exec kindgi corrector-groups add --name=expert --weight=3 --project=<project-id>
pnpm exec kindgi corrector-groups add --name=expert --weight=3 --tenant --min-reviewer-role=senior --description="Order desk leads"

See also

Synopsis

Terminal window
kindgi corrector-groups set <corrector-group-id> [--weight=<w>] [--description=<text>] [[--min-reviewer-role=standard|senior|admin] [--principal-kind=user|service ...] [--principal-id=<id> ...] | --unrestricted]
Signature

Change a corrector group's weight, description, or who may assert it. The restriction flags replace the group's whole restriction; --unrestricted lifts it.

Options

Option Default Description
--description <value> unchanged The new description.
--min-reviewer-role <value> unchanged Only reviewers of this role or above may assert the group: standard, senior, admin.
--principal-id <value> unchanged Only this user or token id may assert the group. Repeat the flag for several. Repeatable.
--principal-kind <value> unchanged Only people (user) or service tokens (service) may assert the group. Repeat the flag for both. Repeatable.
--unrestricted off Lift the restriction: anyone who may correct the run may assert the group.
--weight <value> unchanged The new weight, a number of 0 or more.

Every command also takes the global flags.

Examples

Change a group's weight.

Terminal window
kindgi corrector-groups set <corrector-group-id> --weight=5

Limit who may assert the group to senior reviewers.

Terminal window
kindgi corrector-groups set <corrector-group-id> --min-reviewer-role=senior

Lift the restriction.

Terminal window
kindgi corrector-groups set <corrector-group-id> --unrestricted

See also

Synopsis

Terminal window
kindgi corrector-groups remove <corrector-group-id>
Signature

Retire a corrector group: no new corrections may name it; existing ones keep it.

Options

Every command also takes the global flags.

Examples

Retire a corrector group.

Terminal window
kindgi corrector-groups remove <corrector-group-id>

See also