Plugin CLI reference

Install and manage the pinned first-party Atoi plugin pack.

On this page

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

atoi pluginInstall and manage the pinned first-party Atoi plugin pack.

Command	What it does
`atoi plugin list`	List installed Atoi plugins.
`atoi plugin view`	Read the installed first-party Atoi plugin.
`atoi plugin install`	Install the pinned first-party plugin pack.
`atoi plugin enable`	Enable the installed Atoi plugin.
`atoi plugin disable`	Disable the installed Atoi plugin.
`atoi plugin remove`	Remove the installed Atoi plugin.
`atoi plugin sync`	Compare the installed plugin provenance with the pinned pack.

#`plugin list`

List installed Atoi plugins.

atoi plugin list

Flag	Type	Default	Values	What it does
`--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 `plugin list`

atoi plugin list --json

{
  "tool": "atoi_plugins",
  "arguments": {
    "action": "list"
  }
}

#`plugin view`

Read the installed first-party Atoi plugin.

atoi plugin view <plugin-id>

Flag	Type	Default	Values	What it does
`--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 `plugin view`

atoi plugin view atoi --json

{
  "tool": "atoi_plugins",
  "arguments": {
    "action": "get",
    "plugin_id": "atoi"
  }
}

#`plugin install`

Install the pinned first-party plugin pack.

atoi plugin install creative-int/atoi-plugins [--version <version>] [--from <path>] [--idempotency-key <key>]

Flag	Type	Default	Values	What it does
`--version`	`string`			Require the loaded pack to match this version.
`--from`	`string`			Load the pack from a local path.
`--idempotency-key`	`string`			Reuse a mutation identity when you safely retry the same action.
`--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 `plugin install`

atoi plugin install creative-int/atoi-plugins --json

{
  "tool": "atoi_plugins",
  "arguments": {
    "action": "install",
    "plugin_id": "atoi",
    "idempotency_key": "plugin_install_1"
  }
}

#`plugin enable`

Enable the installed Atoi plugin.

atoi plugin enable <plugin-id> [--idempotency-key <key>]

Flag	Type	Default	Values	What it does
`--idempotency-key`	`string`			Reuse a mutation identity when you safely retry the same action.
`--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 `plugin enable`

atoi plugin enable atoi --json

{
  "tool": "atoi_plugins",
  "arguments": {
    "action": "enable",
    "plugin_id": "atoi",
    "idempotency_key": "plugin_enable_1"
  }
}

#`plugin disable`

Disable the installed Atoi plugin.

atoi plugin disable <plugin-id> [--idempotency-key <key>]

Flag	Type	Default	Values	What it does
`--idempotency-key`	`string`			Reuse a mutation identity when you safely retry the same action.
`--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 `plugin disable`

atoi plugin disable atoi --json

{
  "tool": "atoi_plugins",
  "arguments": {
    "action": "disable",
    "plugin_id": "atoi",
    "idempotency_key": "plugin_disable_1"
  }
}

#`plugin remove`

Remove the installed Atoi plugin.

atoi plugin remove <plugin-id> --confirm [--idempotency-key <key>]

Flag	Type	Default	Values	What it does
`--confirm` required	`boolean`			Confirm the exact consequential action after you inspect its target.
`--idempotency-key`	`string`			Reuse a mutation identity when you safely retry the same action.
`--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 `plugin remove`

atoi plugin remove atoi --confirm --json

{
  "tool": "atoi_plugins",
  "arguments": {
    "action": "remove",
    "plugin_id": "atoi",
    "confirmation": true,
    "idempotency_key": "plugin_remove_1"
  }
}

#`plugin sync`

Compare the installed plugin provenance with the pinned pack.

atoi plugin sync [plugin-id] [--from <path>]

Flag	Type	Default	Values	What it does
`--from`	`string`			Load the observed pack from a local path.
`--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 `plugin sync`

atoi plugin sync atoi --json

Was this useful?

#plugin list

#Run plugin list

#plugin view

#Run plugin view

#plugin install

#Run plugin install

#plugin enable

#Run plugin enable

#plugin disable

#Run plugin disable

#plugin remove

#Run plugin remove

#plugin sync

#Run plugin sync