Skip to content

Goal commands: update, delete

The Goal Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

Reference for Goal, one group of Goal commands.

Goal.update

Changes the given properties of a Goal. Verb page.

Text
npx startup-builder do Goal.update --json '<input>' [--try | --send | --do]

Emits Goal.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Goal.
objectivetextThe qualitative outcome.
horizonstringOne of day, week, quarter, year, or three-years.

Returns

OutputTypeRequiredDescription
goalGoalrequiredThe Goal.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Goal.update --json '{"id":"goal_L9PBQQhfuF","horizon":"day"}'

Goal.delete

Deletes a Goal: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
npx startup-builder do Goal.delete --json '<input>' [--try | --send | --do]

Emits Goal.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Goal.

Returns

OutputTypeRequiredDescription
goalGoalrequiredThe Goal.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Goal.delete --json '{"id":"goal_L9PBQQhfuF"}'