Banyan CLI

Your Banyan apps,
from the terminal.

One command-line tool for Outpilot, Hazel, Scribe, Ivy, Taproot and Canopy. Sign in once with a Banyan CLI key. Readable tables for you, JSON for scripts and AI agents.

curl -fsSL https://api.getbanyan.co/install/banyan/banyan.sh | bash
Install

Installed and signed in, in three steps

  1. 1.

    Install the CLI

    curl -fsSL https://api.getbanyan.co/install/banyan/banyan.sh | bash

    Needs Node.js 20 or newer, on macOS or Linux. On Windows, run it inside WSL. The installer checks the download against its published checksum and puts one file at ~/.local/bin/banyan. If your shell can't find banyan afterwards, add ~/.local/bin to your PATH; the installer prints the line to use.

  2. 2.

    Create a Banyan CLI key

    Sign in to Banyan, then open Settings → Developer and click Create key. Give it a name like "My laptop" and pick an access level (see below). Copy the key straight away: it's shown only once.

  3. 3.

    Sign in and check everything works

    banyan auth login   # paste the key when it asks
    banyan doctor       # checks your key against every app

    The key is saved in ~/.config/banyan/credentials.json, readable only by you. banyan auth status shows which apps it works in.

Try it

One key, six apps

The key works in every Banyan app you use. Add --help to any command to see what it takes.

Outpilot

LinkedIn outreach: campaigns, lead lists, inbox, replies CRM, sender accounts.

banyan outpilot campaigns list --status active
banyan outpilot inbox --help

Hazel

CRM: contacts, companies, deals, pipelines, tasks, email and WhatsApp.

banyan hazel deals list --status OPEN
banyan hazel search "acme"

Scribe

Meeting notetaker: meetings, AI notes, transcripts, recordings, settings.

banyan scribe meetings list
banyan scribe meetings notes <id>

Ivy

WhatsApp marketing: contacts, groups, templates, campaigns, inbox, wallet.

banyan ivy campaigns list
banyan ivy contacts list

Taproot

SEO: projects, keyword research, rank tracking, audits, backlinks, AI visibility.

banyan taproot projects list
banyan taproot usage summary

Canopy

LinkedIn content: posting targets, drafts, the schedule, content plans, comments.

banyan canopy targets list
banyan canopy posts --help
Access levels

You decide what a key can do

Every key has one of three levels. Each app's server enforces it, so it holds for anything that uses the key, a script or an AI agent included.

Read only

Look at your data. Changes nothing.

Read & write

Look at and change your data: add contacts, edit deals, draft posts and campaigns. The default.

Read, write & execute

Also take actions that reach real people: send LinkedIn messages and invites, send email and WhatsApp, send the Scribe bot into a meeting, launch campaigns, publish posts.

Whatever its level, a key can't pay bills, top up credit, or connect LinkedIn accounts or WhatsApp numbers. Those stay in the web app. You can turn execute on or off for a key, or revoke it, at any time in Settings → Developer. A revoked key stops working within a minute.

For scripts and AI agents

Predictable output, safe by default

In a terminal you get tables. Piped, or with --json, every command prints one JSON envelope, with suggested next commands in breadcrumbs. Anything that would reach real people needs an execute key, and deletions need --yes.

$ banyan outpilot campaigns list --json
{
  "ok": true,
  "data": { "campaigns": [ { "id": 12, "name": "Founders IN", "status": "active", … } ] },
  "summary": "3 campaign(s)",
  "breadcrumbs": ["banyan outpilot campaigns show <id>", "banyan outpilot campaigns stats <id>", …]
}

Discover every command

banyan commands --json

A machine-readable list of every command, argument and flag in every app. Add --idempotency-key to any command so a retry never runs it twice.

Exit codes

  • 0 Success
  • 1 The app refused or failed the request (validation, not found, conflict)
  • 2 Bad arguments, or a missing --yes on something destructive
  • 3 Not signed in, or the key's access level doesn't allow it
  • 4 Couldn't reach Banyan (network down or timed out)
Update

One command

banyan update --check   # just look
banyan update           # install the latest

The update is checksum-verified and tested before it replaces anything.

Uninstall

Remove it cleanly

rm ~/.local/bin/banyan
rm -rf ~/.config/banyan ~/.local/state/banyan ~/.cache/banyan

Then revoke the key in Settings → Developer.

Run Banyan from your terminal.

Create a CLI key and you're signed in to every app.