CLI Reference

Concourse ships a single top-level concourse wrapper script that dispatches to a family of subcommands for managing the server, inspecting data, performing administrative tasks, and working with the interactive shell. This page is a one-stop reference covering every subcommand.

Lifecycle

Command	Purpose
concourse start	Start the server as a daemon
concourse stop	Stop the running server
concourse restart	Stop then start
concourse console	Run the server in the foreground
concourse status	Report whether the server is running
concourse version	Print the installed version

Diagnostics

Command	Purpose
concourse threaddump / tdump	Capture a thread dump
concourse heapdump / hdump	Capture a heap dump
concourse monitor <subcommand>	Live metric dashboards; see Monitoring

Shell

concourse shell launches the interactive CaSH environment. Common flags:

Flag	Purpose
-e <env>	Connect to a specific environment
-u <user>	Authenticate as <user>
--password <pwd>	Provide the password non-interactively
--host <host>	Override the connection host
--port <port>	Override the connection port

User Management

concourse users <subcommand> manages accounts, roles, and environment permissions. See User Management for the detailed reference.

Subcommand	Purpose
create	Add a new user (role and password required)
edit	Change a user’s role and/or password
password	Change a user’s password
delete	Remove a user
grant	Grant an environment-scoped permission
revoke	Revoke permissions in an environment
suspend	Disable a user’s account
enable	Re-enable a suspended account
sessions	List currently active sessions

Data Management

concourse data <subcommand> operates on local storage.

Subcommand	Purpose
repair	Detect and fix corrupt data files
compact	Suggest that the server compact data files
list	List dumpable storage units in the environment
dump <id>	Dump a storage unit’s contents in a readable format

All subcommands accept -e <env> to scope to a specific environment.

Environment Management

Subcommand	Purpose
concourse environments list	List all environments on the server

Environments are created on first write; see Introduction.

Plugin Management

concourse plugin <subcommand> (aliased to plugins) controls installed plugins. See Using Plugins.

Subcommand	Purpose
install <path>	Install a plugin from a local path or marketplace name
ps	List information about running plugins
uninstall <bundle>	Remove an installed plugin

Import / Export

Command	Purpose
concourse import <path>	Import a CSV/JSON file. See Imports
concourse export <query>	Export data to CSV or Excel. See Export

Configuration

Subcommand	Purpose
concourse config view	Print the effective configuration
concourse config set	Update a setting
concourse config delete	Unset a setting

See Configuration for the full set of available keys.

Monitoring

concourse monitor <subcommand> is covered in detail in Monitoring. In brief:

Subcommand	Reports
overview	Aggregated summary of every section
storage	Segments, disk, caches, compaction
operations	Per-operation count and latency
transactions	Commit/abort/retry counts
locks	Active locks, wait and hold times
heap	Heap and non-heap memory usage
gc	GC counts and pause totals
threads	Live, peak, daemon thread counts
transport	Buffer → Database transport state
compaction	Compaction progress and queue depth

Authentication

Every management CLI accepts a common set of authentication flags:

Flag	Purpose
-u / --username	Admin username
--password	Admin password (hidden prompt when omitted)
-h / --host	Target server host
-p / --port	Target server port

If omitted, authentication details default to the values in concourse_client.yaml or are prompted for interactively.