Getting Started

Installation

Go

Requires Go 1.24+.

go install ancla.dev/cli@latest

Python

uv tool install ancla

Or with pip:

pip install ancla

Homebrew

brew install SideQuest-Group/ancla-client/ancla

npm / Bun

Run without installing:

npx ancla
# or
bunx ancla

Or install globally:

npm install -g ancla
# or
bun install -g ancla

Cargo

Requires cargo-binstall.

cargo binstall ancla

Binary

Download from GitHub Releases:

macOS (Apple Silicon)

curl -Lo ancla.tar.gz https://github.com/SideQuest-Group/ancla-client/releases/latest/download/ancla_darwin_arm64.tar.gz
tar xzf ancla.tar.gz
chmod +x ancla
sudo mv ancla /usr/local/bin/

macOS (Intel)

curl -Lo ancla.tar.gz https://github.com/SideQuest-Group/ancla-client/releases/latest/download/ancla_darwin_amd64.tar.gz
tar xzf ancla.tar.gz
chmod +x ancla
sudo mv ancla /usr/local/bin/

Linux (amd64)

curl -Lo ancla.tar.gz https://github.com/SideQuest-Group/ancla-client/releases/latest/download/ancla_linux_amd64.tar.gz
tar xzf ancla.tar.gz
chmod +x ancla
sudo mv ancla /usr/local/bin/

Verify the install:

ancla version

Quick start

1. Log in

ancla login

This opens your browser for authentication. See the Authentication guide for CI and manual options.

2. List your workspaces

ancla workspaces list

3. List projects

ancla projects list --workspace my-ws

4. Deploy a service

ancla services deploy my-ws/my-project/production/my-service

5. Check deploy status

ancla services status my-ws/my-project/production/my-service

6. Link your project directory

ancla link my-ws/my-project/production/my-service

Now commands like status, logs, run, and down know what service you’re working on without extra arguments. See Project Linking for details.

Next steps

• Platform Overview — how Ancla organizes workspaces, projects, environments, and services
• Deploy Pipeline — what happens between ancla deploy and your app being live
• Secrets & Config — encrypted variables, scopes, inheritance
• Project Linking — link your directory to skip typing workspace/project/env/service on every command
• Development Workflow — deploy, monitor, run locally, scale, and tear down
• Remote Access — SSH, database shell, cache management
• Scripting & Automation — JSON output, quiet mode, CI/CD patterns
• Authentication — browser login, manual keys, CI setup
• Configuration — config files, env vars, precedence
• Shell Completion — tab completion for your shell
• CLI Reference — full command documentation