AblyDocs

Connections test

Open in

Use the ably connections test command to test your connection to Ably using different transport protocols.

Synopsis

ably connections test [options]

Options

--transport

The transport protocol to test. Valid options are ws (WebSocket), xhr (HTTP), or all. The default value is all.

--client-id

The client ID to use for the connection test.

--json

Output results as compact JSON. Mutually exclusive with --pretty-json.

--pretty-json

Output results in formatted JSON. Mutually exclusive with --json.

--verbose | -v

Enable verbose logging. Can be combined with --json or --pretty-json.

Examples

Test all transport protocols:

ably connections test

Test WebSocket connectivity only:

ably connections test --transport ws

Test HTTP connectivity only:

ably connections test --transport xhr

Test connectivity and output results in JSON format:

ably connections test --json

See also