Key Result commands: create, get, list

Reference for Key Result, one group of Key Result commands.

KeyResult.create

Creates a Key Result. Verb page.

Text

npx startup-builder do KeyResult.create --json '<input>' [--try | --send | --do]

Emits KeyResult.created.

Inputs

Input	Type	Required	Description
`baseline`	`number`	required	Where the Metric started.
`target`	`number`	required	Where the Metric must reach.
`deadline`	`date`	required	When it must reach it.
`goal`	Goal		A Goal is met when its Key Results reach their targets.
`metric`	Metric		A Key Result compares one Metric’s value against its baseline and target.

Returns

Output	Type	Required	Description
`keyResult`	Key Result	required	The Key Result.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

npx startup-builder do KeyResult.create --json '{"baseline":1,"target":1,"deadline":"2026-10-22"}'

Returns one Key Result by id. Verb page.

Text

npx startup-builder do KeyResult.get --json '<input>' [--try]

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Key Result.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`keyResult`	Key Result	required	The Key Result.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

npx startup-builder do KeyResult.get --json '{"id":"kr_fN3pcvG8sq"}'

Returns Key Results, newest first, one page at a time. Verb page.

Text

npx startup-builder do KeyResult.list --json '<input>' [--try]

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`keyResults`	list of Key Result	required	One page of Key Results.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

npx startup-builder do KeyResult.list --json '{"limit":20}'