Installation
WorkFlow ships as a single self-contained binary, wf. There's no runtime to install — just the executable and (optionally) git and a clipboard helper.
One-line install
curl -sSfL https://raw.githubusercontent.com/stack-bound/workflow/master/install.sh | shThis script:
- detects your OS and architecture (Linux/macOS, amd64/arm64),
- downloads the latest release from GitHub,
- installs the
wfbinary to~/.local/bin(no sudo required), - adds that directory to your
PATHif it isn't already (updating your shell rc file), and - installs shell completions for bash, zsh, or fish.
Install somewhere else
Set INSTALL_DIR to choose the install location:
INSTALL_DIR=~/bin curl -sSfL https://raw.githubusercontent.com/stack-bound/workflow/master/install.sh | shFrom source
If you have a Go toolchain, install directly with go install:
go install github.com/stack-bound/workflow/cmd/wf@latestThis puts wf in your $GOBIN (usually ~/go/bin) — make sure that's on your PATH.
Building locally
Cloning the repo? make build produces ./wf, and make install drops it into ~/.local/bin (override with INSTALL_DIR), the same place the install script uses — so there's no duplicate wf on your PATH.
Requirements
| Dependency | Required? | Used for |
|---|---|---|
| git | Yes | All worktree, branch, status, and merge operations |
| tmux | Optional | Real windows per workspace, jump-to-window, sidebar, resurrect |
| A clipboard helper | Optional | wf copy — xclip, xsel, wl-clipboard (Linux), or pbcopy (macOS) |
WorkFlow shells out to git and tmux rather than reimplementing them, so it uses whatever versions you already have.
Verify the install
wf versionYou should see the installed version printed. If wf isn't found, confirm the install directory is on your PATH (open a new shell, or source your rc file).
Shell completions
The install script sets these up for you. To (re)install or manage them yourself, see Shell Integration.
Next steps
Head to Getting Started to register your first project and create a workspace.