Quickstart
Install the Stacksync CLI on macOS, Linux or Windows, log in to your workspace and check that everything works.
This page gets the Stacksync CLI installed and logged in. It takes about two minutes. When you are done, build your first workflow connector.
Prerequisites
- A Stacksync account with access to a workspace. Create an account if you don't have one.
- macOS (Apple Silicon or Intel), Linux (x64 or arm64) or Windows (x64).
- Python 3.10 or later. The CLI itself needs no Python, but
stacksync workflow-connector runuses it to run your connector on your machine. gitis optional. When it is installed,createstarts a Git repository in the new project.
Install and log in
Install the CLI
The CLI is a standalone program. You don't need pip or a virtual environment to install it.
curl -fsSL https://cli.stacksync.com/install.sh | shThe installer detects your operating system and CPU, downloads the matching archive and installs the stacksync command in your home folder (~/.local/bin). It never asks for a password. It also adds that folder to your shell's PATH, so stacksync runs from any folder once you open a new terminal.
To install somewhere else:
curl -fsSL https://cli.stacksync.com/install.sh | STACKSYNC_INSTALL_DIR=~/bin shTo install a specific version instead of the latest one:
curl -fsSL https://cli.stacksync.com/install.sh | sh -s -- v1.0.11Check the installation:
stacksync --versionstacksync, version 1.0.11Read the installer before running it
The installer is a short shell script. To read it before it runs, download it first:
curl -fsSL https://cli.stacksync.com/install.sh -o install.sh
less install.sh
sh install.shEvery release is published at https://cli.stacksync.com/<version>/, and https://cli.stacksync.com/latest returns the current version. The archives are:
| Archive | Platform |
|---|---|
stacksync-macos-arm64.tar.gz | macOS, Apple Silicon |
stacksync-macos-x64.tar.gz | macOS, Intel |
stacksync-linux-x64.tar.gz | Linux, x64 |
stacksync-linux-arm64.tar.gz | Linux, arm64 |
stacksync-windows-x64.zip | Windows, x64 |
Log in
stacksync loginChoose how to authenticate:
Select Log in via the web. Your browser opens the Stacksync login page. If it doesn't open, copy the link that the terminal prints. After you sign in, pick the default workspace in the terminal.
If you are already logged in on this machine, stacksync login offers to keep the existing login. If you log in again through the web, Stacksync generates a new key and the previous one stops working.
Log in without prompts
In CI, on a remote machine, or when an AI agent drives the CLI, there is no terminal to answer the prompts. Pass the API key and the workspace id instead:
stacksync login --api-key <api-key> --workspace <workspace-id>The CLI also reads them from the STACKSYNC_API_KEY and STACKSYNC_WORKSPACE environment variables:
export STACKSYNC_API_KEY=<api-key>
export STACKSYNC_WORKSPACE=<workspace-id>
stacksync loginTo find the workspace id, see Workspaces and regions.
Check your setup
stacksync login --checkIt prints Logged in and exits with code 0, or prints Not logged in and exits with code 1. Scripts and AI agents can use it to decide whether to log in first.
Run stacksync on its own to see the welcome screen with the getting-started commands, and stacksync -h to list every command. stacksync logout logs this machine out.
Keep the CLI up to date
The CLI keeps itself up to date. To update on demand, run stacksync update.
On version 1.0.10 or earlier, run stacksync update once; after that, updates are automatic.
Uninstall
On macOS and Linux, remove the program and its saved login:
rm -rf ~/.local/lib/stacksync ~/.local/bin/stacksync ~/.stacksyncThen delete the line ending in # stacksync CLI PATH from ~/.zshrc, ~/.zprofile, ~/.bashrc and ~/.profile. If you installed with STACKSYNC_INSTALL_DIR, remove the stacksync link from that folder and the lib/stacksync folder next to it. On Windows, delete %LOCALAPPDATA%\stacksync, remove it from your user PATH, and delete the .stacksync folder in your user folder.