Skip to main content

CLI Quickstart

Squawk is the command-line interface for Squawkpipe. Monitor conversations, reply to customers, and pipe conversation data into AI agents — all from your terminal.

Install​

npm install -g @squawkpipe/cli

Homebrew (macOS)​

brew install squawkpipe/tap/squawk

Binary download​

Download the binary for your platform from the latest release:

# macOS (Apple Silicon)
curl -L https://github.com/squawkpipe/squawk/releases/latest/download/squawk-darwin-arm64 -o squawk
chmod +x squawk
sudo mv squawk /usr/local/bin/

# macOS (Intel)
curl -L https://github.com/squawkpipe/squawk/releases/latest/download/squawk-darwin-amd64 -o squawk
chmod +x squawk
sudo mv squawk /usr/local/bin/

# Linux (amd64)
curl -L https://github.com/squawkpipe/squawk/releases/latest/download/squawk-linux-amd64 -o squawk
chmod +x squawk
sudo mv squawk /usr/local/bin/

Authenticate​

squawk login

Opens your browser for sign-in. Credentials are stored securely in your OS keychain.

Verify Installation​

squawk listen

You should see the live monitoring dashboard. Press q to quit.

Configuration​

Set your tenant ID once so you don't have to pass it per command:

export SQUAWK_TENANT_ID=your-tenant-id

Quick Command Reference​

CommandDescription
squawk loginAuthenticate via browser
squawk logoutRemove stored credentials
squawk api-keyStore an API key (for CI/CD or agents)
squawk listenInteractive TUI — watch for new activity
squawk listen --jsonJSONL stream for AI pipelines
squawk conversation <id>Full message history as JSON
squawk conversation <id> -o prettyHuman-readable output
squawk reply <id> --body "..."Send a reply

Next Steps​