SW
Smart Workflow
← Back to Home

Quick Start Guide

Get Smart Workflow up and running in your workspace in just a few minutes.

Prerequisites

  • A Slack workspace where you have admin permissions
  • A GitHub organization with repositories you want to automate
  • Admin access to install GitHub Apps on your organization
1

Install the Slack App

Click the "Add to Slack" button on our website, or use the install link provided by your admin.

This will:

  • •Add Smart Workflow bot to your Slack workspace
  • •Create your organization's account automatically
  • •Enable the bot to receive mentions and messages
2

Install the GitHub App

After installing the Slack app, you'll be redirected to install our GitHub App. Follow these steps:

  1. 1Click "Install GitHub App" button
  2. 2Select your GitHub organization
  3. 3Choose which repositories Smart Workflow can access
  4. 4Click "Install" to complete setup
Tip: You can start with just a few repositories and add more later from your GitHub organization settings.
3

Start Using Commands

You're all set! Mention @Smart Workflow in any channel where the bot is added:

Try your first command
@Smart Workflow explain how the authentication flow works

More examples:

Preview changes before creating a PR:

@Smart Workflow preview my-app add dark mode toggle

Create a pull request:

@Smart Workflow ship landing-page add a contact form with name, email, and message fields

Get AI code review:

@Smart Workflow review https://github.com/org/repo/pull/123

Status Indicators

Watch for these emoji reactions on your messages to track progress:

👀

Request received, processing

⏳

Working on it

✅

Completed successfully

ℹ️

Completed (no changes needed)

⚠️

Completed with warnings

❌

Failed

Troubleshooting

"Your workspace is not set up yet"

Contact your admin to ensure the Slack app and GitHub app are properly installed.

"Repository not found"

Ensure the GitHub App has access to the repository you're targeting.

"PR is closed"

You cannot modify closed PRs. Reopen the PR or create a new one.

Next: Learn all commands

Explore the full command reference to unlock Smart Workflow's potential.

Commands