diff --git a/README.md b/README.md index 9c27fc824..de6974fdc 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ $ npm install -g @ably/cli $ ably COMMAND running command... $ ably (--version) -@ably/cli/0.17.0 darwin-arm64 node-v24.4.1 +@ably/cli/0.17.0 darwin-arm64 node-v22.14.0 $ ably --help [COMMAND] USAGE $ ably COMMAND @@ -76,6 +76,10 @@ $ ably-interactive * [`ably accounts login [TOKEN]`](#ably-accounts-login-token) * [`ably accounts logout [ALIAS]`](#ably-accounts-logout-alias) * [`ably accounts switch [ALIAS]`](#ably-accounts-switch-alias) +* [`ably ai-transport`](#ably-ai-transport) +* [`ably ai-transport demo`](#ably-ai-transport-demo) +* [`ably ai-transport demo barge-in`](#ably-ai-transport-demo-barge-in) +* [`ably ai-transport demo streaming`](#ably-ai-transport-demo-streaming) * [`ably apps`](#ably-apps) * [`ably apps create`](#ably-apps-create) * [`ably apps current`](#ably-apps-current) @@ -382,6 +386,117 @@ EXAMPLES _See code: [src/commands/accounts/switch.ts](https://github.com/ably/ably-cli/blob/v0.17.0/src/commands/accounts/switch.ts)_ +## `ably ai-transport` + +Interact with Ably AI Transport + +``` +USAGE + $ ably ai-transport + +DESCRIPTION + Interact with Ably AI Transport + +EXAMPLES + $ ably ai-transport demo streaming + + $ ably ai-transport demo barge-in + +COMMANDS + ably ai-transport demo Interactive demos of AI Transport features +``` + +_See code: [src/commands/ai-transport/index.ts](https://github.com/ably/ably-cli/blob/v0.17.0/src/commands/ai-transport/index.ts)_ + +## `ably ai-transport demo` + +Interactive demos of AI Transport features + +``` +USAGE + $ ably ai-transport demo + +DESCRIPTION + Interactive demos of AI Transport features + +EXAMPLES + $ ably ai-transport demo streaming + + $ ably ai-transport demo barge-in + + $ ably ai-transport demo cancel +``` + +_See code: [src/commands/ai-transport/demo/index.ts](https://github.com/ably/ably-cli/blob/v0.17.0/src/commands/ai-transport/demo/index.ts)_ + +## `ably ai-transport demo barge-in` + +Demo AI Transport barge-in: interrupt a streaming response mid-flight + +``` +USAGE + $ ably ai-transport demo barge-in [-v] [--json | --pretty-json] [--client-id ] [--role both|client|server] [--channel + ] [--endpoint ] [--auth-endpoint ] + +FLAGS + -v, --verbose Output verbose logs + --auth-endpoint= Auth endpoint returning JWT tokens (client-only, for external servers) + --channel= Channel name to use (auto-generated if not provided) + --client-id= Overrides any default client ID when using API authentication. Use "none" to explicitly + set no client ID. Not applicable when using token authentication. + --endpoint= Server HTTP endpoint for sending messages (client-only, skips presence discovery) + --json Output in JSON format + --pretty-json Output in colorized JSON format + --role=