toc

Evervault CLI

The Evervault CLI helps you manage Cages from your terminal.

Installation

The Evervault CLI is available via npm:

bash
npm install --global @evervault/cli

Commands

The Evervault CLI supports commands related to:

  1. Authentication →
  2. Cages →
  3. Teams →
  4. Support →

Authentication

Use these commands to login and logout of the Evervault CLI.

Login

Log in to the Evervault CLI to get started:

bash
ev login

Logout

Log out from the Evervault CLI:

bash
ev logout

Cages

Use the following commands to manage your Cages.

cage:deploy

Deploy a Cage using the source code of your current directory:

bash
ev cage:deploy [-f|--force]
  • Your current directory needs to contain a package.json and an index.js with an exported handler function.
  • Your Cage will use the name from the directory’s package.json.
  • If you have already deployed the Cage, you will have to confirm the update. Using the --force flag will override this confirmation.

cage:clone

Clone an existing Cage in your current directory.

bash
ev cage:clone [CAGE_NAME] [DIRECTORY]
  • Provide the name of the Cage to be cloned, and the directory for the Cage to be cloned into.

cage:delete

Delete a Cage:

bash
ev cage:delete [-f|--force] [-n|--name=CAGE_NAME]
  • Without the force flag, you will be required to confirm the Cage name before the deletion occurs.

cage:edit

Edit the Cage in the current directory:

bash
ev cage:edit [-n|--name=NEW_CAGE_NAME]
  • The edit command lets you update the name of the Cage deployed from the current directory.
  • This command will update the name field in the package.json

cage:env

Interact with the environment variables of the Cage in the current directory:

bash
ev cage:env (get|set|delete) [-n|--name=ENV_VARIABLE_NAME] [-v|--value=ENV_VARIABLE_VALUE]
  • Allows you to get, set, or delete the environment variables of the Cage in the current directory.
  • If the variable already exists, set will overwrite the current value.
  • Delete and set both require confirmation.

cage:init

Initialize a simple “hello world” Cage either in your current directory, or the directory provided:

bash
ev cage:init [DIRECTORY] [-n|--name=CAGE_NAME]

cage:list

List all of the current team’s Cages:

bash
ev cage:list

cage:logs

Open the Cage logs screen in the Evervault Dashboard for the named Cage:

bash
ev cage:logs [CAGE_NAME]

cage:run

Run a named Cage from the command line using provided flags as a payload:

bash
ev cage:run [CAGE_NAME]
  • All flags will be treated as key value pairs to be used as a payload for the Cage. The CLI will encrypt the flags before sending them into the Cage.

Teams

Use the following commands to manage the teams that you’re a member of.

team:list

List all teams that your account has access to:

bash
ev team:list

team:switch

Switch the team you’re working on in the CLI:

bash
ev team:switch [-n|--name=TEAM_NAME]

Support

help

Display help for the Evervault CLI:

bash
ev help [COMMAND]
  • help is also available as an argument to any command in the CLI.

info

View information about your current session in the Evervault CLI:

bash
ev info

reset

Factory reset of the Evervault CLI:

bash
ev reset
  • reset will wipe all local data.