Rooms list

Use the ably rooms list command to list active chat rooms.

Synopsis

ably rooms list [options]

Options

--limit

The maximum number of rooms to return. Defaults to 100.

--prefix | -p

Filter rooms by a name prefix.

--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

List all active chat rooms:

ably rooms list

Filter rooms by prefix:

ably rooms list --prefix "game-"

List rooms with a custom limit:

ably rooms list --limit 50

List rooms in JSON format:

ably rooms list --json

List rooms in formatted JSON output:

ably rooms list --pretty-json

See also

• Rooms — Explore all ably rooms commands.
• CLI reference — Full list of available commands.