10 Minute Quickstart

Follow along with this guide to get your first Sym workflow up and running!

Overview

If you’re worried about how much time it will take to get your first Sym flow set up, don’t be. We’ve built an easy-install experience that gets your first flow provisioned in minutes, and your first users piloting Sym in hours.

This section walks you through setting up Sym and getting your first workflow up and running.

Prerequisites

To use Sym, you'll need: Terraform, Python 3, and a Sym Organization ID.

📘

You'll need a Sym Organization and Org ID

Go here to create your account and get started with Sym.

Steps

1. Install Sym in your Slack workspace

Sym's setup starts in Slack. If you haven't already, install the Sym app for your Slack workspace by clicking this link. After installing our app, you can run /sym, which will guide you through the rest of the process.

520

2. Install the symflow CLI to manage Sym

The symflow CLI is where you can log in, manage users and other resources, and make updates to your Terraform and Python configurations. For methods other than brew, please refer to this page.

~/Documents/sym/
> brew install symopsio/tap/symflow

~/Documents/sym/
> symflow login
...
Org ID: # enter your Sym Organization ID and then follow your browser to complete login!

3. Initialize Sym and generate your first Sym workflow

Sym provides a symflow init command which will create a new directory for your configuration with the environment and version files, and a symflow generate command which will generate the rest of the files required for your Flows. You'll need to provide your Slack workspace ID, which you can find by running /sym whoami in Slack.

For more information, see:

~/Documents/sym/
> symflow init && symflow generate
Please enter your Slack workspace ID:
# You can find your workspace ID by running `/sym whoami` in Slack.

Successfully generated your Sym Terraform configuration!

~/Documents/sym/example-flow
> terraform init && terraform plan
> terraform apply

4. Run your first Sym workflow in Slack

Once you apply your initial configuration, you can run /sym again from anywhere in Slack to see an example Flow in action.

📘

By default, Sym posts to #sym-requests. Please make sure it exists!

Blocked on Slack?

If you’re stuck waiting for approval to add Sym to Slack, you can always set us up in a test workspace and then come back later. It's really easy to point Sym to different Slack workspaces as needed.

Easy onboarding

Once you have your first Flow set up, the collaborative nature of Slack makes it easy to get new teams onboarded. Direct folks to start using our Slack App and have them learn by doing.