Cased developer and API documentation

Add a comprehensive, high-signal, and tamper-proof audit trail to any application in minutes. Give your compliance, security, and customer support teams the information they need.

Getting started with the CLI

Up and running in minutes

1. Install the client locally

There are several easy ways to install the the cased client. The only requirement is Python 3.5 or better.

For macOS, we strongly recommending installing with Homebrew using:

brew install cased/tap/cased

We also provide a simple shell script for both macOS and Linux distros. Copy-paste this into your terminal:

/bin/bash -c "$(curl -fsSL"

Alternatively you can install it manually by cloning the client repository, and running:


2. Make sure the client is on your PATH when you start a shell

You can now initialize the client. The client is light-weight and agent-less by design, but you do need to make sure cased-init (a single-purpose initialization script) runs every time a shell starts. To do that, just add the following to your ~/.bashrc or ~/.zshrc (or similar) and start a new shell:

eval "$(cased-init -)"

Next configure the client with your unique user token. You can find your token by following the setup instructions for any application listed in your CLI program list .

cased configure <your-user-token>

You can also just run:

cased configure

and sync with a web connection.

Running that action will also "sync" your local client with your Cased Guard remote settings, and install any apps that have been configured (you haven't setup any apps—we'll do that in the next step).

And lastly, start a new shell.

You can confirm the entire installation with:

cased verify

3. Setup an application

From the dashboard, click on the New button, then Set up a local CLI program. Enter the name of the command-line application and click Create CLI Application.

For this example, we're going to use psql, the shell for postgres, in our example. If you don't have psql, make sure to use the name of a command-line application that you do have installed and is on your system's PATH, like terraform and mysql.

To complete the setup, turn on Peer approvals under Settings for the psql app, and then pick a Slack room where approval requests will go.

4. Test it out

Now run:

cased sync

This will sync your local client with the newly-added app. (Please read Installation
Best Practices for more on cased sync, and how to best distribute Cased Guard
within your organization.)

Open up a new shell, and run psql (or whichever program you setup) as usual:

psql postgres

In the configured Slack channel, you'll see an approval request message from the Cased Slack app. Go ahead and approve the request. That's it!

Updated about 4 hours ago

What's Next

Configure An App

Getting started with the CLI

Up and running in minutes

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.