Skip to content

System commands: update, delete

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

Reference for System, one group of System commands.

System.update

Changes the given properties of a System. Verb page.

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

Emits System.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the System.
jobstringThe one job it does.

Returns

OutputTypeRequiredDescription
systemSystemrequiredThe System.

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 System.update --json '{"id":"system_uGWze2jvrp","job":"Example job"}'

System.delete

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

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

Emits System.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the System.

Returns

OutputTypeRequiredDescription
systemSystemrequiredThe System.

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 System.delete --json '{"id":"system_uGWze2jvrp"}'