Channel CLI reference

Inspect, authorize, test, and revoke Atoi Channels.

On this page

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

atoi channelInspect, authorize, test, and revoke Atoi Channels.

Command	What it does
`atoi channel list`	List linked Channels and delivery state.
`atoi channel view`	Read one Channel link.
`atoi channel get`	Read one Channel link with the get alias.
`atoi channel authorize`	Open the browser-owned authorization flow for a Channel kind.
`atoi channel test`	Send a receipt-backed test through one exact Channel link.
`atoi channel revoke`	Revoke one exact Channel link.

#`channel list`

List linked Channels and delivery state.

atoi channel 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 `channel list`

atoi channel list --json

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

#`channel view`

Read one Channel link.

atoi channel view <link-id> [--link <link-id>]

Flag	Type	Default	Values	What it does
`--link`	`string`			Select the exact link 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 `channel view`

atoi channel view lnk_8s3d --json

{
  "tool": "atoi_channels",
  "arguments": {
    "action": "get",
    "channel_id": "chn_7t4b"
  }
}

#`channel get`

Read one Channel link with the get alias.

atoi channel get <link-id> [--link <link-id>]

Flag	Type	Default	Values	What it does
`--link`	`string`			Select the exact link 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 `channel get`

atoi channel get lnk_8s3d --json

{
  "tool": "atoi_channels",
  "arguments": {
    "action": "get",
    "channel_id": "chn_7t4b"
  }
}

#`channel authorize`

Open the browser-owned authorization flow for a Channel kind.

atoi channel authorize <telegram|slack|push>

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 `channel authorize`

atoi channel authorize slack --json

{
  "tool": "atoi_channels",
  "arguments": {
    "action": "authorize",
    "channel_kind": "slack"
  }
}

#`channel test`

Send a receipt-backed test through one exact Channel link.

atoi channel test --link <link-id> [--idempotency-key <key>]

Flag	Type	Default	Values	What it does
`--link` required	`string`			Select the exact link id.
`--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 `channel test`

atoi channel test --link lnk_8s3d --idempotency-key test_release_1 --json

{
  "tool": "atoi_channels",
  "arguments": {
    "action": "test",
    "link_id": "lnk_8s3d",
    "idempotency_key": "channel_test_1"
  }
}

#`channel revoke`

Revoke one exact Channel link.

atoi channel revoke --link <link-id> --confirm [--idempotency-key <key>]

Flag	Type	Default	Values	What it does
`--link` required	`string`			Select the exact link id.
`--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 `channel revoke`

atoi channel revoke --link lnk_8s3d --confirm --json

{
  "tool": "atoi_channels",
  "arguments": {
    "action": "revoke",
    "channel_id": "chn_7t4b",
    "link_id": "lnk_8s3d",
    "confirmation": true,
    "idempotency_key": "channel_revoke_1"
  }
}

Was this useful?

#channel list

#Run channel list

#channel view

#Run channel view

#channel get

#Run channel get

#channel authorize

#Run channel authorize

#channel test

#Run channel test

#channel revoke

#Run channel revoke