@evervault/cli

evervault-cli

The official evervault cli for managing cages

• evervault-cli
• Usage
• Commands

Usage

$ npm install -g @evervault/cli
$ ev COMMAND
running command...
$ ev (-v|--version|version)
@evervault/cli/1.0.1 linux-x64 node-v12.18.4
$ ev --help [COMMAND]
USAGE
  $ ev COMMAND
...

Commands

• ev cage:clone CAGENAME [DIRECTORY]
• ev cage:delete
• ev cage:deploy
• ev cage:edit
• ev cage:env ACTION
• ev cage:init [DIRECTORY]
• ev cage:list
• ev cage:logs [CAGENAME]
• ev cage:run [CAGENAME]
• ev deploy
• ev help [COMMAND]
• ev info
• ev init [DIRECTORY]
• ev login
• ev logout
• ev reset
• ev run [CAGENAME]
• ev team:list
• ev team:switch

ev cage:clone CAGENAME [DIRECTORY]

Clone an existing Cage into your current directory.

USAGE
  $ ev cage:clone CAGENAME [DIRECTORY]

ARGUMENTS
  CAGENAME   The name of the cage to clone.
  DIRECTORY  The directory to clone the cage into.

See code: src/commands/cage/clone.js

ev cage:delete

Delete your Cage.

USAGE
  $ ev cage:delete

OPTIONS
  -f, --force
  -n, --name=name

See code: src/commands/cage/delete.js

ev cage:deploy

Deploy an Evervault Cage from your current directory.

USAGE
  $ ev cage:deploy

DESCRIPTION
  The deployed Cage will use the name given in the package.json

See code: src/commands/cage/deploy.js

ev cage:edit

Edit a deployed Evervault Cage from your current directory.

USAGE
  $ ev cage:edit

OPTIONS
  -n, --name=name

See code: src/commands/cage/edit.js

ev cage:env ACTION

Update your Cage's environment variables.

USAGE
  $ ev cage:env ACTION

ARGUMENTS
  ACTION  (get|set|delete) Type of interaction with your Cage's environment variable

OPTIONS
  -n, --name=name    environment variable name
  -v, --value=value  environment variable value (for set)

See code: src/commands/cage/env.js

ev cage:init [DIRECTORY]

Initialize a "hello world" Cage in your current directory.

USAGE
  $ ev cage:init [DIRECTORY]

ARGUMENTS
  DIRECTORY  The directory to create the "hello world" Cage in.

OPTIONS
  -n, --name=name  Cage Name

See code: src/commands/cage/init.js

ev cage:list

List your team's Cages.

USAGE
  $ ev cage:list

See code: src/commands/cage/list.js

ev cage:logs [CAGENAME]

View the Cage runtime logs in your browser.

USAGE
  $ ev cage:logs [CAGENAME]

ARGUMENTS
  CAGENAME  The name of the Cage to view logs for.

See code: src/commands/cage/logs.js

ev cage:run [CAGENAME]

Run an Evervault Cage from your current directory.

USAGE
  $ ev cage:run [CAGENAME]

ARGUMENTS
  CAGENAME  The Cage to run.

See code: src/commands/cage/run.js

ev deploy

Deploy an Evervault Cage from your current directory.

USAGE
  $ ev deploy

DESCRIPTION
  The deployed Cage will use the name given in the package.json

See code: src/commands/deploy.js

ev help [COMMAND]

display help for ev

USAGE
  $ ev help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

ev info

View your current status in the Evervault CLI.

USAGE
  $ ev info

See code: src/commands/info.js

ev init [DIRECTORY]

Initialize a "hello world" Cage in your current directory.

USAGE
  $ ev init [DIRECTORY]

ARGUMENTS
  DIRECTORY  The directory to create the "hello world" Cage in.

OPTIONS
  -n, --name=name  Cage Name

See code: src/commands/init.js

ev login

Authenticate the CLI with Evervault to get started

USAGE
  $ ev login

See code: src/commands/login.js

ev logout

Log the CLI out of Evervault

USAGE
  $ ev logout

See code: src/commands/logout.js

ev reset

Reset the Evervault CLI to its initial state

USAGE
  $ ev reset

See code: src/commands/reset.js

ev run [CAGENAME]

Run an Evervault Cage from your current directory.

USAGE
  $ ev run [CAGENAME]

ARGUMENTS
  CAGENAME  The Cage to run.

See code: src/commands/run.js

ev team:list

List all teams you have access to

USAGE
  $ ev team:list

See code: src/commands/team/list.js

ev team:switch

Switch the team you are working with in the CLI

USAGE
  $ ev team:switch

OPTIONS
  -n, --name=name  name of the team you want to switch to

See code: src/commands/team/switch.js