CipherStash
CipherStash Documentation

Installing the CipherStash CLI

The CipherStash CLI is the primary way you’ll interact with CipherStash. It allows you to login to a workspace, manage collections, and so on.

In order to install CipherStash CLI, you must have a Linux or macOS computer (or virtual machine) on which you can install software. Windows is not officially supported at this time, although you may have some success with WSL2.

Step 1: Install Dependencies

The CipherStash CLI requires Node.js version 14 or higher. To build the StashJS client library that the CipherStash CLI uses, you will also need:

Installing Dependencies on macOS

Installing the dependencies can be done using Homebrew:

brew install openssl gmp node@16

You will also need the Xcode command line tools which you can usually install via:

xcode-select --install

Installing Dependencies on Linux

Specific steps will depend on your distribution.

Innstalling the build dependencies is typically a matter of asking your package manager nicely. For instance, on Fedora/Centos/Redhat:

sudo dnf install openssl-devel gmp-devel curl make automake gcc

Meanwhile, over in Debian/Ubuntu land:

sudo apt-get install build-essential curl libgmp-dev libssl-dev

Installing Node.js is a slightly more involved proposition. Most Linux distributions don’t ship Node.js v14 or higher. We recommend following the official Node.js documentation to get it installed.

Step 2: Install the CipherStash CLI

We’re on the home stretch now. To install the CipherStash CLI, you can use the Node.js package manager, npm, to install the stash command:

sudo npm install -g @cipherstash/stash-cli

Step 3: Login to CipherStash

Exciting times, we’re ready to get an access token and connect to CipherStash!

With the ID of the workspace that you found earlier in hand, run this command:

stash login --workspace <workspaceID>

This command will prompt you to visit an authentication URL under auth.cipherstash.com. You might have to login again, if you haven’t visited the Console in a while. Once logged in, you should be presented with a page that looks like this:

Device Code Authentication Confirmation Dialog

Click the “Confirm” button to approve the creation of your access token.

Congratulations!

You are now logged into CipherStash in your local development environment. The next thing to do is to create your first collection of sources.