cairn CLI

cairn is the command-line client for Cairn — pipe something in, get a shareable link back.

$ cat incident-notes.md | cairn
✓ pushed  ·  markdown  ·  ⧗ expires 7d  ·  link access
https://cairn.stump.wtf/9qz1a

What this repository is

This repository distributes the cairn client binary. It contains no source code. The releases here are prebuilt binaries; the client's source lives in a private repository.

The client is MIT licensed. The Cairn server is proprietary and is not distributed — not here, and not anywhere else. Installing this gets you the command-line client for talking to a Cairn server you already have access to.

Issues and pull requests opened here will not reach the developers — see Support.

Install

Homebrew (macOS and Linux)

brew tap stump-wtf/tap
brew install cairn

Direct download

Binaries are attached to each release for macOS and Linux on both amd64 and arm64, plus Windows. Download the archive for your platform, verify it against checksums.txt, then put the binary on your PATH:

VERSION=0.1.0
OS=darwin          # or: linux
ARCH=arm64         # or: amd64

BASE="https://github.com/stump-wtf/cairn-cli/releases/download/v${VERSION}"
curl -sSLO "${BASE}/cairn_${VERSION}_${OS}_${ARCH}.tar.gz"
curl -sSLO "${BASE}/checksums.txt"

# Verify before extracting. This must print "OK" — if it does not, stop.
shasum -a 256 --ignore-missing --check checksums.txt

tar -xzf "cairn_${VERSION}_${OS}_${ARCH}.tar.gz"
sudo mv cairn /usr/local/bin/

On Linux, sha256sum --ignore-missing --check checksums.txt is the equivalent verification step.

Check the install:

cairn --version

Point it at a server

cairn defaults to the hosted service at https://cairn.stump.wtf. To use a different deployment, set CAIRN_URL or pass --url:

export CAIRN_URL=https://cairn.example.com

Authenticate

Sign in to the web UI, open Settings → API tokens, and mint a personal access token. Then:

cairn login          # paste the token at the hidden prompt
cairn whoami

The token is stored in your operating system's keychain when one is available, and otherwise in a 0600 file in your config directory. It is never logged or printed. cairn logout removes only that local copy — to revoke the token itself, use the Settings page.

Use it

cat notes.md | cairn                          # one artifact from stdin
cairn report.md                               # one artifact from a file
cairn add audit.md fix.patch disk-usage.png   # several files, one bundle

cairn --ttl 24h --title "incident notes" incident.md

Useful flags: --ttl (30m, 24h, 7d), --title, --tag (repeatable), --type to override the detected media type, --json for machine-readable output, and --no-copy to leave your clipboard alone.

On an interactive terminal cairn copies the resulting link to your clipboard and prints a summary. When piped it prints only the bare link, so it composes:

url=$(cat report.md | cairn)

Documentation

Full guides and the API reference are at https://cairn.stump.wtf/docs/.

Support

Because this repository carries binaries rather than source, its issue tracker is not monitored. For bugs, questions, or access requests, contact the person who gave you access to the Cairn deployment you are using.

License

The cairn client is MIT licensed — see LICENSE, which states what the grant covers. The Cairn server is proprietary and is not distributed under it.