Engineers can use the CLI to:

1. Assume IAM roles, Kubernetes roles, start database sessions, and SSH sessions
2. Get info on a particular resource
3. Use SCP to copy files to and from a compute instance

Setup

You'll need the following:

• Homebrew
• AWS CLI
• AWS CLI - Session Manager Plugin
• Node v18 or later

Install

OSX

Installing Opal's CLI is simple using Homebrew:

brew install opalsecurity/brew/opal-security

To upgrade the CLI, please use:

brew update
brew upgrade opal-security

Linux and Windows

On these platforms, you can install directly from npm:

npm install -g opal-security

Usage

Please see our npm page for a full list of all our current CLI commands.

Troubleshooting

If you run into errors from Node (e.g. incompatible architecture), please make sure your local environment is using the Node version that you installed the Opal CLI on.

If you're using nvm, you can view a list of installed Node versions via nvm ls and switch using nvm use <VERSION>.