stokeDocumentation

Start here

Overview

Stoke brings Kiln and Bellows into one workspace for local GitHub Actions feedback. Bellows plans and runs the workflows; Kiln supplies the runner environment.

Clone Stoke and set up the pair. Each tool keeps its own source, history and releases.

Open documentation →
↑ ↓ navigate↵ open
On this page

Bellows

Installation

Bellows is distributed as a single binary.

Homebrew

Homebrew distribution is available from the Smeltery tap.

Terminal
brew tap smeltery/tap
brew install --cask smeltery/tap/bellows

Verify:

Terminal
bellows --version
bellows self-test

Go Install

Terminal
go install github.com/smeltery/bellows@latest

Make sure $(go env GOPATH)/bin is on your PATH.

For private Smeltery module access, configure Go to bypass the public proxy and checksum database for the organization:

Terminal
go env -w GOPRIVATE=github.com/smeltery/*
go env -w GONOSUMDB=github.com/smeltery/*
GOPROXY=direct go install github.com/smeltery/bellows@latest

Release Archives

Download archives from GitHub Releases when a tagged release is available:

Terminal
gh release download --repo smeltery/bellows --pattern "bellows_*_$(go env GOOS)_$(go env GOARCH).tar.gz"

Runtime Dependencies

Bellows shells out to act and Docker.

Install act:

Terminal
brew install act

Install and start a Docker-compatible runtime:

  • Docker Desktop

  • Rancher Desktop

  • Colima

  • another runtime that exposes the Docker CLI/socket

Check the local environment:

Terminal
bellows doctor

bellows doctor reports whether act is available and Docker is reachable.

Shell Completions

Generate completions with:

Terminal
bellows completion zsh
bellows completion bash
bellows completion fish

For zsh with Homebrew:

Terminal
bellows completion zsh > "$(brew --prefix)/share/zsh/site-functions/_bellows"

For bash with Homebrew:

Terminal
mkdir -p "$(brew --prefix)/etc/bash_completion.d"
bellows completion bash > "$(brew --prefix)/etc/bash_completion.d/bellows"

For fish:

Terminal
mkdir -p ~/.config/fish/completions
bellows completion fish > ~/.config/fish/completions/bellows.fish

Optional: pre-commit

Bellows can generate a hook for the pre-commit framework.

Terminal
brew install pre-commit

Then initialize Bellows with hook support:

Terminal
bellows init --pre-commit
pre-commit install --hook-type pre-push
Continue readingQuickstart →
Edit on GitHub
Open in chat

Opens with this page’s documentation in the prompt.