Spaces members enter

Open in

Use the ably spaces members enter command to enter a space and remain present until terminated.

Synopsis

ably spaces members enter <space-name> [options]

Arguments

space-name
Required

The name of the space to enter.

Options

--profile

JSON profile data to associate with the member.

--duration | -D

The duration in seconds to remain present before automatically leaving.

--client-id

A client ID to use when entering the space.

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

Enter a space:

ably spaces members enter my-space

Enter a space with profile data:

ably spaces members enter my-space --profile '{"name": "Alice", "avatar": "avatar-1"}'

Enter a space for a specific duration:

ably spaces members enter my-space --duration 120

Enter a space and output the result in JSON format:

ably spaces members enter my-space --json

See also

  • Spaces — Explore all ably spaces commands.
  • CLI reference — Full list of available commands.