# Install couchbase-shell with Homebrew, Nix

Modern and fun shell for Couchbase Server and Capella. Version 1.3.0 via Homebrew; verified 2026-05-12.

## Install

```sh
sudo av install brew:couchbase-shell
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install couchbase-shell
```

  Evidence: local Homebrew formula metadata

### Linux

- Nix (92%):

```sh
nix profile install nixpkgs#couchbase-shell
```

  Evidence: nixpkgs package indexes: pkgs/by-name/co/couchbase-shell/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

## Package facts

- **Package key:** brew:couchbase-shell
- **Package manager:** Homebrew
- **Package manager page:** <https://formulae.brew.sh/formula/couchbase-shell>
- **Version:** 1.3.0
- **Source summary:** Modern and fun shell for Couchbase Server and Capella
- **Homepage:** <https://couchbase.sh>
- **Repository:** <https://github.com/couchbaselabs/couchbase-shell>
- **Upstream docs:** <https://couchbase.sh/>
- **License:** Apache-2.0
- **Source archive:** <https://github.com/couchbaselabs/couchbase-shell/archive/refs/tags/v1.3.0.tar.gz>
- **Last updated:** 2026-05-12T09:55:09Z
- **Generated:** 2026-07-08T07:18:31+00:00

## Executables

- cbsh (cli)
- cbsh (alias)

## Build dependencies

- pkgconf
- rust

## Install behavior

- Post-install hook: not defined
- Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux

## Freshness

- Page generated: 2026-07-08
- Package-manager version: 1.3.0
- Package-manager updated: 2026-05-12
- Local data: ok
- Upstream repository: https://github.com/couchbaselabs/couchbase-shell
- Upstream latest detected: v1.3.0 (current)
## Project history and usage

Couchbase Shell is the Couchbase-maintained `cbsh` command-line shell for Couchbase Server and Couchbase Capella, implemented and distributed as a standalone CLI.

### Project history

The public GitHub repository was created in 2020 under `couchbaselabs`, and the README describes the project as maintained by Couchbase with community support through the issue tracker rather than Couchbase Enterprise Edition support.

The project reached a tagged 1.0.0 release in 2024 after earlier beta and 0.75.x releases, with later 1.x releases continuing through 2026.

### Adoption history

Official packaging emphasizes downloadable archives for Linux, macOS, and Windows, while the Homebrew formula and Nix package make it available through common developer package managers.

### How it is used

`cbsh` is used to connect to Couchbase clusters, run commands for buckets, queries, analytics, search, users, Capella projects, and related administrative tasks, and can persist cluster connection details in `~/.cbsh/config`.

### Why package nerds care

For package maintainers, Couchbase Shell is notable as a vendor-maintained database shell that ships batteries-included release artifacts and sits alongside Couchbase's older command-line tools rather than replacing a single generic `couchbase` binary.

### Timeline

- 2020: Public GitHub repository created.
- 2021: 1.0.0 beta releases appear.
- 2024: 1.0.0 release published.
- 2026: 1.3.0 release published.

### Related projects

- Couchbase Server
- Couchbase Capella
- Nushell

### Sources

- <https://github.com/couchbaselabs/couchbase-shell>
- <https://api.github.com/repos/couchbaselabs/couchbase-shell>
- <https://github.com/couchbaselabs/couchbase-shell/releases>
- <https://docs.couchbase.com/cloud/reference/command-line-tools.html>
- <https://couchbase.sh/docs/>


## Security Notes

generalized runtime or code generation signal.

- **Geiger risk:** yellow / medium
- generalized runtime or code generation signal


## Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.


## Configuration files

- Unix: ~/.cbsh/config

## Credential files

- Unix: ~/.cbsh/config
## Source Database Details

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** couchbase-shell
- **Version Scheme:** 0
- **Revision:** 0
- **Head Version:** HEAD
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** head, stable

## Other Package-Manager Records

- Nix - couchbase-shell: normalized package name match | nixpkgs package indexes: pkgs/by-name/co/couchbase-shell/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1


## Related links

- [Secret-risk packages](https://www.automicvault.com/pkg/secret-risk-packages/) - Has protected-tool coverage, approval-gate, or non-low Geiger security signals.
- [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [Networking and protocol packages](https://www.automicvault.com/pkg/networking-protocol-tools/) - Matched network, protocol, or remote-service metadata.
- [pkgconf](https://www.automicvault.com/pkg/brew/pkgconf/) - Build dependency declared by Homebrew.
- [rust](https://www.automicvault.com/pkg/brew/rust/) - Build dependency declared by Homebrew.
- [rainfrog](https://www.automicvault.com/pkg/brew/rainfrog/) - Shares av.db curated category or tags: cli, data, database, database-tools.
- [cassandra-reaper](https://www.automicvault.com/pkg/brew/cassandra-reaper/) - Shares av.db curated category or tags: cli, data, database-tools.
- [cqlkit](https://www.automicvault.com/pkg/brew/cqlkit/) - Shares av.db curated category or tags: cli, data, database-tools.
- [percona-toolkit](https://www.automicvault.com/pkg/brew/percona-toolkit/) - Shares av.db curated category or tags: cli, data, database-tools.
- [psql2csv](https://www.automicvault.com/pkg/brew/psql2csv/) - Shares av.db curated category or tags: cli, data, database-tools.
- [apache-geode](https://www.automicvault.com/pkg/brew/apache-geode/) - Shares av.db curated category or tags: cli, data, database.
- [arcadedb](https://www.automicvault.com/pkg/brew/arcadedb/) - Shares av.db curated category or tags: cli, data, database.
- [astra](https://www.automicvault.com/pkg/brew/astra/) - Shares av.db curated category or tags: cli, data, database.

## Combined YAML source

View the package source record on GitHub. [combined/couchbase-shell.yml](https://github.com/automic-vault/db/blob/main/combined/couchbase-shell.yml)


## Sources

- Nucleus package database
- Geiger risk classifier
- package-page enrichment
- curated configuration and credential file locations
- curated package history
- package version freshness
- av.db category and tag curation
- package relationship graph
- external package-manager database matches
- cross-ecosystem install command graph
