Sym

Sym Docs

Welcome to the Sym docs!

Sym is the security workflow platform made for engineers, by engineers. We build primitives for best-practice controls so you don't have to!

If you're not sure where to start, check out Sym Concepts, or read the Sym Manifesto.
If you're implementing a Sym Flow, you might also want to check out our SDK Docs.

    

Install

Initial install of the Sym CLI

Automatic Install

Installing the sym CLI is as simple as running one command:

curl https://install.symops.io/sym.sh | bash

If your install succeeded, you should now have sym in your path.

$ sym version
0.1.22

That's it! Everything else you need has been installed for you.

📘

If the install script fails for any reason, we have a few alternatives.

Manual Install

Use your preferred package manager, or download a macOS installer.

brew install symopsio/tap/sym
pipx install sym-cli
pip install --user sym-cli
$ curl -LO https://github.com/symopsio/sym-cli-releases/releases/latest/download/sym-cli-darwin-x64.pkg
$ sudo installer -pkg sym-cli-darwin-x64.pkg -target /
$ curl -LO https://github.com/symopsio/sym-cli-releases/releases/latest/download/sym-cli-linux-x64.deb
$ sudo dpkg -i sym-cli-linux-x64.deb

AWS CLI and Session Manager Plugin

Using SSH with the CLI requires that you have both the AWS CLI and the AWS Session Manager CLI Plugin installed and on your path. Sym uses Session Manager to securely connect to EC2 instances in your environment.

🚧

If you install sym manually, you will also have to install these tools.

📘

To install the Session Manager Plugin on ArchLinux, you can use rpm2archive to pull out the session-manager-plugin binary and add it to your path.

Upgrade

To check for any updates run:

$ sym update
Quickly checking for Sym CLI updates...no updates found, carry on!

📘

sym has an auto-updater that'll check periodically and install the update for you.

Updated about a month ago


What's Next

Login

Install


Initial install of the Sym CLI

Suggested Edits are limited on API Reference Pages

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