Install the symflow CLI


The symflow CLI is what you use to configure Sym for your organization. You'll need to be logged in to apply Terraform changes, or to list and manage Users, Domains, Resources, or Services.

That said, for the most part, you will be creating and managing Resources via Terraform, and Sym will manage your users for you via Identity Discovery.


Do you have a Sym account?

If not, you can go here to create your account and get started with Sym.

Install the CLI

To install the symflow CLI, use one of the commands below:

brew install symopsio/tap/symflow
pipx install sym-flow-cli
pip install --user sym-flow-cli

# Please ensure ~/.local/bin is added to your PATH
curl -LO
sudo installer -pkg sym-flow-cli-darwin-x64.pkg -target /
curl -LO
sudo dpkg -i sym-flow-cli-linux-x64.deb


We'll have to log in before we can do anything else. Sym also supports SSO, if your organization has set it up.

$ symflow login
Org ID: # enter your Sym Organization ID and then follow your browser to complete login!

First-time login

If it's your first time logging into Sym, you won't have an account yet. To make one, just click "Sign Up" on your first login and enter a username and password. You'll then be required to verify your email. Once that's done, you can run symflow login again, enter the credentials you used to create the account, and complete your setup.


Next steps

With symflow installed, you can now run symflow init to generate your first Flow!

What’s Next