Key Result commands: update, delete
The Key Result Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Key Result, one group of Key Result commands.
KeyResult.update
Changes the given properties of a Key Result. Verb page.
npx startup-builder do KeyResult.update --json '<input>' [--try | --send | --do]Emits KeyResult.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Key Result. |
baseline | number | Where the Metric started. | |
target | number | Where the Metric must reach. | |
deadline | date | When it must reach it. |
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
npx startup-builder do KeyResult.update --json '{"id": "kr_fN3pcvG8sq", "baseline": 1}'KeyResult.delete
Deletes a Key Result: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do KeyResult.delete --json '<input>' [--try | --send | --do]Emits KeyResult.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Key Result. |
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
npx startup-builder do KeyResult.delete --json '{"id": "kr_fN3pcvG8sq"}'