Atkins ships as a single binary with no runtime dependencies. You can install it from source using Go, download a pre-built binary, or copy it from the official Docker image. Choose whichever method fits your environment.
From Source (Go)
If you have Go 1.21+ installed, this is the simplest method:
go install github.com/titpetric/atkins@latest
The binary will be placed in your $GOPATH/bin
directory.
Binary Release
Pre-built binaries are available for Linux and macOS (amd64 and arm64):
- Navigate to the Releases page
- Download the binary for your platform
- Install to your PATH:
# Example for Linux amd64
curl -L https://github.com/titpetric/atkins/releases/latest/download/atkins-linux-amd64 -o /usr/local/bin/atkins
chmod +x /usr/local/bin/atkins
Docker
Atkins is available as titpetric/atkins:latest
. You can copy the binary into your own images or run it directly.
Add it to your Dockerfile:
COPY --from=titpetric/atkins:latest /usr/local/bin/atkins /usr/local/bin/atkins
Or run it directly:
docker run --rm -v $PWD:/app titpetric/atkins -l
The image is built from scratch in docker/Dockerfile . See docker/Dockerfile.example for a full example.
Verify Installation
After installation, verify Atkins is working:
# Print version
atkins -v
# List tasks in current directory
atkins -l
# Run default task
atkins
Shebang Support (Linux/macOS)
On Unix systems, pipeline files can be made directly executable using a shebang line:
#!/usr/bin/env atkins
name: My Script
tasks:
default:
steps:
- run: echo "Hello from executable pipeline!"
Then:
chmod +x my-pipeline.yml
./my-pipeline.yml
Atkins strips the shebang line before parsing, so the file remains valid YAML for other tools.
Next Steps
- Configuration - Learn the pipeline format
- CLI Flags - Command-line reference