Channels presence get

Use the ably channels presence get command to get all current presence members on a channel.

Synopsis

ably channels presence get <channel-name> [options]

Arguments

channel-name

Required

The name of the channel to get presence members for.

Options

--limit

The maximum number of presence members to return. Defaults to 100.

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

Get all presence members on a channel:

ably channels presence get my-channel

Get presence members with a limit:

ably channels presence get my-channel --limit 10

Get presence members in JSON format:

ably channels presence get my-channel --json

Get presence members in formatted JSON output:

ably channels presence get my-channel --pretty-json

See also

• Channels — Explore all ably channels commands.
• CLI reference — Full list of available commands.