Installation

The abadge CLI is a single compiled binary built with Bun. It runs on macOS and Linux (x86_64 and arm64).

Recommended: install script

curl -fsSL https://raw.githubusercontent.com/punitarani/abadge/main/install.sh | bash

The script:

Detects your OS, architecture, and (on Linux) libc (glibc baseline or musl).
Downloads the latest signed CLI release archive from GitHub.
Verifies the SHA-256 checksum against the published SHA256SUMS file.
Extracts the binary to ~/.abadge/bin/abadge.
Adds ~/.abadge/bin to your shell profile’s PATH if it’s not already there.

After install:

abadge --version

By default the install script installs both abadge and abadge-mcp. To install only one:

# CLI only
ABADGE_INSTALL_PACKAGE=cli \
  curl -fsSL https://raw.githubusercontent.com/punitarani/abadge/main/install.sh | bash

# MCP server only — see also /mcp/installation
ABADGE_INSTALL_PACKAGE=mcp \
  curl -fsSL https://raw.githubusercontent.com/punitarani/abadge/main/install.sh | bash

Pinning a version

When installing a single package, ABADGE_VERSION pins that package’s release:

ABADGE_INSTALL_PACKAGE=cli ABADGE_VERSION=1.4.2 \
  curl -fsSL https://raw.githubusercontent.com/punitarani/abadge/main/install.sh | bash

When installing multiple packages, use the scoped variables — ABADGE_VERSION is rejected to avoid ambiguity:

ABADGE_CLI_VERSION=1.4.2 ABADGE_MCP_VERSION=0.0.2 \
  curl -fsSL https://raw.githubusercontent.com/punitarani/abadge/main/install.sh | bash

Custom install paths

Variable	Default	Effect
`ABADGE_INSTALL_PACKAGE`	`all`	`cli`, `mcp`, or `all`
`ABADGE_INSTALL_DIR`	`~/.abadge/bin`	Where binaries are installed
`ABADGE_INSTALL_REPO`	`punitarani/abadge`	GitHub repo to fetch from
`ABADGE_INSTALL_BASE_URL`	(GitHub releases)	Override the release archive URL
`ABADGE_CLI_VERSION`	(latest stable `cli-v*`)	Pin the CLI release
`ABADGE_MCP_VERSION`	(latest stable `mcp-v*`)	Pin the MCP release
`ABADGE_VERSION`	(none)	Fallback for single-package installs
`PROFILE`	(auto-detected)	Shell profile file to update

Build from source

If you’ve cloned the monorepo:

# Run from a TypeScript entrypoint
bun run cli -- --help

# Compile a binary into /tmp
bun run release:cli:dry-run -- --outdir /tmp/abadge-cli-release
/tmp/abadge-cli-release/abadge --version

The release script ships in scripts/releases/publish.ts. Pass --dry-run to skip the publish step.

What gets installed where

Path	Purpose	Permissions
`~/.abadge/bin/abadge`	The CLI binary	`0755`
`~/.abadge/config.json`	CLI config (created on first `login`)	`0600`
`~/.abadge/agents/*.jwk`	Local Ed25519 private keys	`0600`
`~/.abadge/vaultd.sock`	Daemon Unix socket (created on `daemon start`)	`0600`
`~/.abadge/vaultd.pid`	Daemon PID file	`0644`

Verify the installation

abadge --version
abadge --help

If abadge isn’t found, source your shell profile (source ~/.zshrc, source ~/.bashrc) or restart the shell.

Next steps

Configuration

The shape of ~/.abadge/config.json and where state lives.

Login

Authenticate via the device-code flow.

Quickstart

Store a secret, register an agent, run with the secret injected.

Getting started

Authentication

Local daemon

Resources

Runtime

Data movement

Recommended: install script

Pinning a version

Custom install paths

Build from source

What gets installed where

Verify the installation

Next steps

Configuration

Login

Quickstart

​Recommended: install script

​Pinning a version

​Custom install paths

​Build from source

​What gets installed where

​Verify the installation

​Next steps

Configuration

Login

Quickstart

Recommended: install script

Pinning a version

Custom install paths

Build from source

What gets installed where

Verify the installation

Next steps