Skip to content
weside.aiweside docs

CLI

The weside CLI brings your companion to the terminal. Same companion, same memory as the app — for people who’d rather not leave the command line. It sits on the same REST API and, for two commands, the same MCP server the we plugin uses. One companion, three ways in.

What it is

Section titled “What it is”

An open-source Go CLI (Apache 2.0), at github.com/weside-ai/weside-cli. It ships 38 top-level commands and 158 leaf commands in total — this page covers the groups you’ll reach for; weside --help and weside <command> --help are the complete, always-current source, and never go stale the way a page can.

Terminal window
# Homebrew (macOS/Linux)
brew tap weside-ai/tap
brew install weside-cli


# npm
npm install -g weside-cli


# Shell script
curl -fsSL https://raw.githubusercontent.com/weside-ai/weside-cli/main/scripts/install.sh | sh


# From source
go install github.com/weside-ai/weside-cli@latest

Pre-built binaries for Linux, macOS (Intel + Apple Silicon), and Windows are on the releases page.

Why it matters to you

Section titled “Why it matters to you”

Everything the app does, the CLI does too — chat, memory, goals, rooms, stickers, plans and credits, account management — and it speaks --json everywhere, so it drops into scripts and pipelines instead of staying a one-off terminal toy.

How you use it

Section titled “How you use it”

Sign in once, then talk to your companion:

Terminal window
weside auth login                # log in
weside companions list           # see your companions
weside companions select nox     # pick a default
weside chat -m "Hey, how are you?"
weside chat --stream -m "Tell me a story"

weside auth login opens a browser for a standard OAuth login (PKCE) — pick Google, Apple, or email there, same as signing in on the web or in the app. weside auth login --dev and the WESIDE_TOKEN environment variable are developer/CI shortcuts for headless machines, not the everyday path.

The command groups, by what they’re for:

  • Companions — companions list | show | create | select | update | delete, plus care and setup: companions prompts show | versions | restore, companions identity, companions resume, companions skills available | install | list | set | uninstall, companions tools list | set.
  • Chat & rooms — chat [companion] (-m/--message, -f/--file, --stream, --abort-after), piped input (echo "Hi" | weside chat nox); the v2 chat model is room-based, so conversation management is rooms list | show | dm | group | rename | delete | participants | mute | unmute | activity | confirmations | events.
  • Memories & goals — memories search "query" | list | get | save | edit | update | delete, goals list | save | update | edit | reorder. Memory search is semantic, not keyword — “how does auth work” finds memories about authentication even without the word.
  • Vault: notes, files, ablage — ablage search, files tree | upload | delete | keep | quota, notes list | get | write | delete | search | recent | working-set, stage list | delete, and a cross-vault search that covers memories, notes, and files together.
  • Stickers — stickers workshop slots | generate | reroll | keep | discard | style to design a sticker, stickers packs list | show | upload | publish | export, and stickers send.
  • Invites & safety — invite mint | rotate | show | accept for room invitations, safety block | unblock | blocked | report for trust & safety actions.
  • Provider & data residency — provider show | presets | set | byok | byok-discover | byok-test | eu-only; see connect your own model key.
  • Plan, credits, referrals — plans me | show, billing usage | purchase-eligibility, me usage, referrals create | list | revoke | stats.
  • Account & data rights — me-account export | deactivate | profile | profile-set | locale | sliding-window.
  • Integrations & the sandbox vault — integrations catalog | list | disconnect | reconcile, sandbox-secrets put | list | delete | presets.
  • Attention — triggers list | set | toggle | delete, subscriptions list | toggle, reminders list | dismiss, evolution presets | start | current | dismiss, experts list | befriend, mentor-sessions.
  • Circles & channels — circles create | list | delete, channels list | set-active.
  • Tools — tools discover and tools exec <name> '<json>' for the actions your companion can perform.
  • Config and escape hatches — config show | set | system | refresh-auth, user-config get | set | delete, completion, version, and api <path> for a raw authenticated call (marked (debug) in --help).

Limits & edge cases

Section titled “Limits & edge cases”
  • api, rooms trace, rooms tool-call, and notes-repo repair are diagnostic verbs, not everyday ones — --help labels api (debug) outright. Reach for them when you’re troubleshooting, not as your first move.
  • Only two verbs go through MCP. weside memories save and weside tools talk to the same MCP server the we plugin uses; everything else in this list is a direct REST call.
  • Self-hosting an auth backend? --supabase-url and --supabase-anon-key are the escape hatch; without them, the CLI discovers your auth endpoint from /.well-known/weside-auth. Global flags on every command: --json, --verbose, --config, --api-url, --no-color, --supabase-url, --supabase-anon-key.
Terminal window
weside companions list --json | jq '.companions[0].name'
curl -H "Authorization: Bearer $(weside auth token)" https://api.weside.ai/api/v1/auth/me

Where next

Section titled “Where next”