Automation CLI reference

Create and operate reusable manual or scheduled work.

On this page

Use this page to inspect every public atoi automation command, its accepted flags, and one runnable example. Return to the CLI reference index to choose another command group.

atoi automationCreate and operate reusable manual or scheduled work.

Command	What it does
`atoi automation list`	List Automations, optionally for one Project or only active entries.
`atoi automation get`	Read one Automation and its recent runs.
`atoi automation create`	Create a manual or scheduled Automation.
`atoi automation update`	Change an Automation definition or schedule.
`atoi automation toggle`	Toggle an Automation between active and paused.
`atoi automation trigger`	Start an Automation run immediately.
`atoi automation remove`	Remove one exact Automation.

#`automation list`

List Automations, optionally for one Project or only active entries.

atoi automation list [--project <project-id>] [--enabled-only]

Flag	Type	Default	Values	What it does
`--project`	`string`			Select a Project by id.
`--enabled-only`	`boolean`			Return only enabled Automations.
`--json`	`boolean`	`false`		Emit the canonical JSON envelope.
`--ndjson`	`boolean`	`false`		Emit one canonical JSON envelope per line.
`--format`	`string`	`text`	`text`, `json`	Choose human text or the JSON envelope.
`--help` `-h`	`boolean`			Show command help.

#Run `automation list`

atoi automation list --project prj_8k2v --json

{
  "tool": "atoi_automations",
  "arguments": {
    "action": "list",
    "project_id": "prj_8k2v",
    "limit": 10
  }
}

#`automation get`

Read one Automation and its recent runs.

atoi automation get <automation-id> [--automation <automation-id>] [--limit <n>]

Flag	Type	Default	Values	What it does
`--automation`	`string`			Select an Automation by id instead of a positional id.
`--limit`	`number`			Limit the number of returned records.
`--json`	`boolean`	`false`		Emit the canonical JSON envelope.
`--ndjson`	`boolean`	`false`		Emit one canonical JSON envelope per line.
`--format`	`string`	`text`	`text`, `json`	Choose human text or the JSON envelope.
`--help` `-h`	`boolean`			Show command help.

#Run `automation get`

atoi automation get aut_5k1m --json

{
  "tool": "atoi_automations",
  "arguments": {
    "action": "get",
    "automation_id": "aut_5k1m"
  }
}

#`automation create`

Create a manual or scheduled Automation.

atoi automation create --name <name> --prompt <prompt> [--description <text>] [--project <project-id>] [--model <model-id>] [--schedule <manual|daily|interval|monthly>] [schedule flags] [--enabled|--no-enabled]

Flag	Type	Default	Values	What it does
`--name` required	`string`			Set the Automation name.
`--prompt` required	`string`			Set the Automation prompt.
`--description`	`string`			Describe the Automation.
`--project`	`string`			Select a Project by id.
`--model`	`string`			Select a model id.
`--schedule`	`string`	`manual`	`manual`, `daily`, `interval`, `monthly`	Choose the schedule type.
`--hour-utc`	`number`			Set the UTC hour from 0 through 23.
`--minute-utc`	`number`			Set the UTC minute from 0 through 59.
`--hours`	`number`			Set the interval from 1 through 8760 hours.
`--days`	`string`			Set unique comma-separated weekdays from 0 through 6.
`--day-of-month`	`number`			Set the calendar day from 1 through 31.
`--enabled`	`boolean`			Create the Automation enabled or disabled. Pass --no-enabled for false.
`--json`	`boolean`	`false`		Emit the canonical JSON envelope.
`--ndjson`	`boolean`	`false`		Emit one canonical JSON envelope per line.
`--format`	`string`	`text`	`text`, `json`	Choose human text or the JSON envelope.
`--help` `-h`	`boolean`			Show command help.

#Run `automation create`

atoi automation create --name "Release audit" --prompt "Audit main and return evidence." --schedule daily --hour-utc 14 --minute-utc 30 --json

{
  "tool": "atoi_automations",
  "arguments": {
    "action": "create",
    "project_id": "prj_8k2v",
    "name": "Release check",
    "prompt": "Check the candidate tag.",
    "schedule": {
      "type": "daily",
      "hourUTC": 14,
      "minuteUTC": 0
    }
  }
}

#`automation update`

Change an Automation definition or schedule.

atoi automation update <automation-id> [--automation <automation-id>] [--name <name>] [--prompt <prompt>] [--description <text>] [--project <project-id|all|none>] [--model <model-id>] [--schedule <type>] [schedule flags] [--enabled|--no-enabled]

Flag	Type	Default	Values	What it does
`--automation`	`string`			Select an Automation by id instead of a positional id.
`--name`	`string`			Replace the Automation name.
`--prompt`	`string`			Replace the Automation prompt.
`--description`	`string`			Replace the Automation description.
`--project`	`string`			Select a Project, or pass all or none to clear Project scope.
`--model`	`string`			Select a model id.
`--schedule`	`string`		`manual`, `daily`, `interval`, `monthly`	Choose the schedule type.
`--hour-utc`	`number`			Set the UTC hour from 0 through 23.
`--minute-utc`	`number`			Set the UTC minute from 0 through 59.
`--hours`	`number`			Set the interval from 1 through 8760 hours.
`--days`	`string`			Set unique comma-separated weekdays from 0 through 6.
`--day-of-month`	`number`			Set the calendar day from 1 through 31.
`--enabled`	`boolean`			Enable or disable the Automation. Pass --no-enabled for false.
`--json`	`boolean`	`false`		Emit the canonical JSON envelope.
`--ndjson`	`boolean`	`false`		Emit one canonical JSON envelope per line.
`--format`	`string`	`text`	`text`, `json`	Choose human text or the JSON envelope.
`--help` `-h`	`boolean`			Show command help.

#Run `automation update`

atoi automation update aut_5k1m --description "Audit the candidate release." --json

{
  "tool": "atoi_automations",
  "arguments": {
    "action": "update",
    "automation_id": "aut_5k1m",
    "prompt": "Check the candidate tag and changelog."
  }
}

#`automation toggle`

Toggle an Automation between active and paused.

atoi automation toggle <automation-id> [--automation <automation-id>]

Flag	Type	Default	Values	What it does
`--automation`	`string`			Select an Automation by id instead of a positional id.
`--json`	`boolean`	`false`		Emit the canonical JSON envelope.
`--ndjson`	`boolean`	`false`		Emit one canonical JSON envelope per line.
`--format`	`string`	`text`	`text`, `json`	Choose human text or the JSON envelope.
`--help` `-h`	`boolean`			Show command help.

#Run `automation toggle`

atoi automation toggle aut_5k1m --json

{
  "tool": "atoi_automations",
  "arguments": {
    "action": "toggle",
    "automation_id": "aut_5k1m",
    "enabled": true
  }
}

#`automation trigger`

Start an Automation run immediately.

atoi automation trigger <automation-id> [--automation <automation-id>] [--input <message>]

Flag	Type	Default	Values	What it does
`--automation`	`string`			Select an Automation by id instead of a positional id.
`--input`	`string`			Add an input message for this run.
`--json`	`boolean`	`false`		Emit the canonical JSON envelope.
`--ndjson`	`boolean`	`false`		Emit one canonical JSON envelope per line.
`--format`	`string`	`text`	`text`, `json`	Choose human text or the JSON envelope.
`--help` `-h`	`boolean`			Show command help.

#Run `automation trigger`

atoi automation trigger aut_5k1m --input "Check the candidate tag." --json

{
  "tool": "atoi_automations",
  "arguments": {
    "action": "trigger",
    "automation_id": "aut_5k1m",
    "input_message": "Check the candidate tag."
  }
}

#`automation remove`

Remove one exact Automation.

atoi automation remove <automation-id> [--automation <automation-id>] --confirm

Flag	Type	Default	Values	What it does
`--automation`	`string`			Select an Automation by id instead of a positional id.
`--confirm` required	`boolean`			Confirm the exact consequential action after you inspect its target.
`--json`	`boolean`	`false`		Emit the canonical JSON envelope.
`--ndjson`	`boolean`	`false`		Emit one canonical JSON envelope per line.
`--format`	`string`	`text`	`text`, `json`	Choose human text or the JSON envelope.
`--help` `-h`	`boolean`			Show command help.

#Run `automation remove`

atoi automation remove aut_5k1m --confirm --json

{
  "tool": "atoi_automations",
  "arguments": {
    "action": "remove",
    "automation_id": "aut_5k1m",
    "confirmation": true
  }
}

Was this useful?

#automation list

#Run automation list

#automation get

#Run automation get

#automation create

#Run automation create

#automation update

#Run automation update

#automation toggle

#Run automation toggle

#automation trigger

#Run automation trigger

#automation remove

#Run automation remove