skills.rest
cockroachdb
cockroachdbOFFICIAL
Explore all skills by this author →
WebsiteGitHub

setting-up-local-cluster

Launch and configure a local CockroachDB cluster for development.

3|3|Updated Mar 11, 2026
Search Tags:#local-development#cockroachdb#cluster-setup#download-binary#3-node-cluster#single-node
One-click install
npx skills add https://github.com/cockroachdb/claude-plugin --skill setting-up-local-cluster
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: setting-up-local-cluster
Source: https://github.com/cockroachdb/claude-plugin/tree/main/skills/onboarding-and-migrations/setting-up-local-cluster
Command: npx skills add https://github.com/cockroachdb/claude-plugin --skill setting-up-local-cluster

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Downloads and starts a local CockroachDB cluster for development using the official binary. Use when a developer needs a local CockroachDB instance, when no cluster is available, or when setting up a new development environment.

Core Features & Use Cases

  • Platform-aware binary download and setup for CockroachDB to kick off a local development environment.
  • Support for both a 3-node cluster (recommended for realistic testing) and a single-node setup for lightweight development.
  • Clear guidance on connection details, environment variables (COCKROACHDB_*) and lifecycle management (start, stop, destroy) for development workflows.

Quick Start

Run the built-in setup to download the CockroachDB binary and start a 3-node local cluster for development.

Frequently Asked Questions about setting-up-local-cluster

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up a local CockroachDB cluster for development?▼

A local CockroachDB cluster requires downloading the official binary and running the built-in setup to start a 3-node cluster for realistic testing or a single-node setup for lightweight development.

What's the difference between a single-node and 3-node CockroachDB cluster?▼

A 3-node CockroachDB cluster is recommended for realistic testing, simulating a production environment, while a single-node setup offers a lightweight development experience on your local machine.

Do I need a remote CockroachDB cluster to test changes locally?▼

No remote cluster is needed. You can launch a local CockroachDB cluster using the official binary to validate changes directly in your development environment.

How do I manage the lifecycle of a local CockroachDB cluster?▼

A local CockroachDB cluster lifecycle is managed using specific commands to start, stop, and destroy data, ensuring clean environment resets for your development workflows.

How do I verify connectivity to a local CockroachDB cluster?▼

Connectivity to a local CockroachDB cluster is verified using exposed environment variables and connection details, allowing your development applications to communicate with the database.

Related Skills

Explore More Software Engineering Skills→
gear-foundationgear-foundation
17

sails-dev-env

Automate cross-platform setup of Rust toolchains, Sails CLI, and Gear binary.

Official
Intermediate
mysticaltechmysticaltech
3.9k

test-changes

Run terraform fmt, validate, and plan against a test environment.

Community
Intermediate
zizzfizzixzizzfizzix

migrate-orm

Automate database schema migrations for ORM-based applications.

Community
Intermediate
ShadylukinShadylukin
74

neumann-deploy

Deploy Neumann clusters and single-node instances across Docker Compose and Kubernetes.

Community
Advanced