> For the complete documentation index, see [llms.txt](https://tools.docs.sendbird.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tools.docs.sendbird.com/readme/commands/account-and-cli-commands.md).

# Account commands

Use these commands for:

* [Account authentication](#account-authentication)
* [Profiles](#profiles)
* [Organizations and regions](#organizations-and-regions)
* [Applications and security](#applications-and-security)
* [Project context](#project-context)
* [CLI Skill registration](#cli-skill-registration)
* [Discovery and diagnostics](#discovery-and-diagnostics)
* [Plans and billing](#plans-and-billing)
* [Support](#support)

Each table lists a command's own options. For options shared by all commands and for reading results, see [CLI reference](/readme/commands.md).

## Account authentication

| Command                             | Purpose                                                                                | Command-specific inputs      |
| ----------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------- |
| `sendbird setup`                    | Log in, select an organization and app, and optionally save them as defaults.          | No command-specific options. |
| `sendbird auth login`               | Log in through the browser.                                                            | No command-specific options. |
| `sendbird auth signup`              | Sign up in the browser, then return to the CLI.                                        | No command-specific options. |
| `sendbird auth status`              | Show the current login and its permissions.                                            | `--summary`                  |
| `sendbird auth verify-email`        | Verify your account's email with the link from the verification email or a token file. | `--token-file <value>`       |
| `sendbird auth resend-verification` | Resend the signed-in account's email verification message.                             | No command-specific options. |
| `sendbird auth logout`              | Log out and revoke the saved login.                                                    | No command-specific options. |

## Profiles

| Command                   | Purpose                                             | Command-specific inputs          |
| ------------------------- | --------------------------------------------------- | -------------------------------- |
| `sendbird profile`        | Show the selected profile and saved active profile. | No command-specific options.     |
| `sendbird profile list`   | List saved environment profiles.                    | No command-specific options.     |
| `sendbird profile create` | Create a profile for an environment.                | `--name <value>` `--env <value>` |
| `sendbird profile use`    | Select a profile.                                   | `--name <value>`                 |
| `sendbird profile delete` | Revoke saved credentials and delete a profile.      | `--name <value>`                 |

## Organizations and regions

| Command                    | Purpose                                                                                                                         | Command-specific inputs                                                                                                                                                               |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sendbird org list`        | List the organizations you can access.                                                                                          | No command-specific options.                                                                                                                                                          |
| `sendbird org get`         | Get an organization.                                                                                                            | No command-specific options.                                                                                                                                                          |
| `sendbird org create`      | Create an organization.                                                                                                         | `--organization-name <value>` `--contact <value>`                                                                                                                                     |
| `sendbird org use`         | Check access to an organization and select it. This clears the selected app.                                                    | `--id <value>`                                                                                                                                                                        |
| `sendbird org clear`       | Clear the saved organization, app, and region selections.                                                                       | No command-specific options.                                                                                                                                                          |
| `sendbird org region list` | List Chat regions available to the selected organization.                                                                       | No command-specific options.                                                                                                                                                          |
| `sendbird org region use`  | Select a Chat region for future app creation.                                                                                   | `--id <value>`                                                                                                                                                                        |
| `sendbird org sso get`     | Read the authenticated organization's SAML configuration; public certificate is masked.                                         | No command-specific options.                                                                                                                                                          |
| `sendbird org sso set`     | Configure SAML with explicit organization confirmation. Enforcing SSO requires `--login-tested true`.                           | `--confirm-org-name <value>` `--login-tested <value>` `--entity-id <value>` `--sso-enforcing <value>` `--jit-provisioning <value>` `--sso-default-role <value>` `--slug-name <value>` |
| `sendbird org sso delete`  | Remove the SAML configuration. Requires the organization name and `--yes`. Review how members will log in before you remove it. | `--confirm-org-name <value>`                                                                                                                                                          |

## Applications and security

| Command                            | Purpose                                                                                                                                     | Command-specific inputs                                                                                 |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `sendbird app list`                | List the apps you can access.                                                                                                               | `--limit <value>` `--offset <value>` `--app-name-or-app-id <value>`                                     |
| `sendbird app get`                 | Get the app's details and authentication policy.                                                                                            | No command-specific options.                                                                            |
| `sendbird app use`                 | Check access to an app and select it.                                                                                                       | `--id <value>`                                                                                          |
| `sendbird app create`              | Create an app in the organization, optionally with Calls. With Calls and `--claim-trial`, also request the organization's free Calls trial. | `--app-name <value>` `--region <value>` `--is-calls-enabled <value>` `--claim-trial` `--no-claim-trial` |
| `sendbird app clear`               | Clear the saved application selection.                                                                                                      | No command-specific options.                                                                            |
| `sendbird app rename`              | Rename the selected application.                                                                                                            | `--app-name <value>`                                                                                    |
| `sendbird app sdk-config`          | Show the app's SDK API and WebSocket endpoints.                                                                                             | No command-specific options.                                                                            |
| `sendbird app feature list`        | List the features turned on for the app.                                                                                                    | No command-specific options.                                                                            |
| `sendbird app feature set`         | Turn one app feature on or off, within your plan. Requires `--yes`.                                                                         | `--feature <value>` `--enabled <value>`                                                                 |
| `sendbird app auth-policy get`     | Read the app's token policy. The CLI shows it as **Token policy**, and the JSON field is `guest_user_policy`.                               | No command-specific options.                                                                            |
| `sendbird app auth-policy set`     | Set the app's token policy. Accepted values are `0`, `1`, and `2`.                                                                          | `--guest-user-policy <value>`                                                                           |
| `sendbird app ip-allowlist get`    | Read the app's IP allowlist.                                                                                                                | No command-specific options.                                                                            |
| `sendbird app ip-allowlist add`    | Add IP/CIDR entries; confirm the current source IP and exact application name first.                                                        | `--confirm-app-name <value>` `--confirm-source-ip <value>` `--ip-whitelist-addresses <value>`           |
| `sendbird app ip-allowlist remove` | Remove IP/CIDR entries; confirm the current source IP and exact application name first.                                                     | `--confirm-app-name <value>` `--confirm-source-ip <value>` `--ip-whitelist-addresses <value>`           |
| `sendbird app partition get`       | Read Open-channel partitioning settings and participant limits.                                                                             | No command-specific options.                                                                            |
| `sendbird app partition set`       | Change the Open-channel partitioning mode.                                                                                                  | `--option-type <value>`                                                                                 |
| `sendbird app delete`              | Delete the selected app and its data. Requires the exact app name and `--yes`.                                                              | `--confirm-app-name <value>`                                                                            |

## Project context

| Command                   | Purpose                                                        | Command-specific inputs      |
| ------------------------- | -------------------------------------------------------------- | ---------------------------- |
| `sendbird project status` | Read the local Sendbird project file.                          | No command-specific options. |
| `sendbird project init`   | Create `sendbird.json` from the selected organization and app. | No command-specific options. |

## CLI Skill registration

| Command                   | Purpose                                                                | Command-specific inputs             |
| ------------------------- | ---------------------------------------------------------------------- | ----------------------------------- |
| `sendbird skills install` | Register the bundled CLI Skill for Claude Code or Codex, offline.      | `--agent <value>` `--scope <value>` |
| `sendbird skills status`  | Show registered Skills and their versions.                             | `--agent <value>` `--scope <value>` |
| `sendbird skills show`    | Read the bundled CLI Skill and its reference paths without installing. | No command-specific options.        |
| `sendbird skills remove`  | Remove only an unchanged Skill registered by this CLI.                 | `--agent <value>` `--scope <value>` |

## Discovery and diagnostics

| Command              | Purpose                                                                                       | Command-specific inputs                                                                     |
| -------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `sendbird doctor`    | Check your login, plan, features, and what a command needs, without changing anything.        | `--command <value>` `--type <value>` `--id <value>` `--as-user <value>` `--region <value>`  |
| `sendbird agent`     | Show a short guide to the CLI for AI coding agents.                                           | No command-specific options.                                                                |
| `sendbird commands`  | List or search the command catalog. Use `--compact --search '<WORDS>'` to narrow the results. | `--compact` `--search <words...>` `--transport <kind>` `--limit <count>` `--offset <count>` |
| `sendbird describe`  | Show one command's options, authentication, and an example.                                   | Required command path, such as `chat message send`.                                         |
| `sendbird help`      | Display help for a command or command group.                                                  | Optional command path, such as `chat message send`.                                         |
| `sendbird workflows` | List or show named task sequences. Workflows don't run the steps.                             | Optional workflow name.                                                                     |

## Plans and billing

| Command                         | Purpose                                                                                                                                      | Command-specific inputs                       |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| `sendbird billing plan current` | Read current and scheduled Chat subscriptions for the selected organization.                                                                 | `--product <value>`                           |
| `sendbird billing plan list`    | Read the organization's plan catalog. Requires the `organization.general.all` permission. Entries aren't eligibility checks or price quotes. | No command-specific options.                  |
| `sendbird billing plan check`   | Check the Chat plan selection, billing channel, and payment readiness. The result isn't a price quote.                                       | `--plan <value>`                              |
| `sendbird billing plan change`  | Prepare a Chat plan change for you to finish on Sendbird Dashboard. This command doesn't change billing.                                     | `--plan <value>` `--confirm-org-name <value>` |
| `sendbird billing plan verify`  | Check whether the requested Chat plan is current, scheduled, or not yet applied.                                                             | `--plan <value>`                              |

## Support

| Command                          | Purpose                               | Command-specific inputs                                                                                                                                        |
| -------------------------------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sendbird support ticket submit` | Submit a Chat technical support case. | `--subject <value>` `--description <value>` `--development-platform-c <value>` `--sdk-version-c <value>` `--steps-to-reproduce-c <value>` `--priority <value>` |
