Skip to content

QUICKSTART.md

Latest commit

 

History

History
168 lines (124 loc) · 3.69 KB

QUICKSTART.md

File metadata and controls

168 lines (124 loc) · 3.69 KB

Beeper CLI Quick Start

Get up and running with Beeper CLI in under 5 minutes.

Prerequisites

  • Beeper Desktop installed and running
  • Terminal access

Step 1: Install

Option A: Download Pre-built Binary (Recommended)

macOS (Apple Silicon)

curl -L https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-api-darwin-arm64 -o beeper
chmod +x beeper
sudo mv beeper /usr/local/bin/

macOS (Intel)

curl -L https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-api-darwin-amd64 -o beeper
chmod +x beeper
sudo mv beeper /usr/local/bin/

Linux (amd64)

curl -L https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-api-linux-amd64 -o beeper
chmod +x beeper
sudo mv beeper /usr/local/bin/

Windows Download from: https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-api-windows-amd64.exe

Option B: Build from Source

git clone https://github.com/nerveband/beeper-api-cli
cd beeper-api-cli
go build -o beeper .
sudo mv beeper /usr/local/bin/

Step 2: Configure

Auto-discover your Beeper Desktop API:

beeper discover

Expected output:

Discovering Beeper Desktop API...
Found Beeper Desktop API at: http://localhost:39867
Configuration saved successfully!

Manual Configuration (if auto-discovery fails):

beeper config set-url http://localhost:39867

Step 3: Verify Installation

Check your configuration:

beeper config show

Expected output:

API URL: http://localhost:39867
Output Format: json

Step 4: List Your Chats

beeper chats list

You should see JSON output with all your Beeper conversations.

Human-Readable Format

beeper chats list --output text

Step 5: Send Your First Message

  1. Get a chat ID from the previous command
  2. Send a message:
beeper send --chat-id YOUR_CHAT_ID --message "Hello from Beeper CLI!"

Common Commands

List messages from a chat

beeper messages list --chat-id CHAT_ID --limit 20

Search for messages

beeper search --query "important meeting"

Change output format

beeper chats list --output markdown
beeper chats list --output text

Next Steps

  • LLM Integration: See examples/llm-integration.sh for advanced usage
  • Full Documentation: Read README.md for complete command reference
  • API Details: Check API.md for endpoint documentation

Troubleshooting

"Could not auto-discover Beeper Desktop API"

  • Ensure Beeper Desktop is running
  • Check if port 39867 is accessible: curl http://localhost:39867/health
  • Try manual configuration: beeper config set-url http://localhost:PORT

"API error (status 404)"

  • Verify Beeper Desktop API server is enabled in settings
  • Check the API URL is correct: beeper config show

Commands not working

Getting Help

Example Workflow

# 1. Setup
beeper discover

# 2. Explore your chats
beeper chats list --output text

# 3. Get chat ID you want to message
CHAT_ID="your_chat_id_here"

# 4. Read recent messages
beeper messages list --chat-id $CHAT_ID --limit 10

# 5. Send a message
beeper send --chat-id $CHAT_ID --message "Testing Beeper CLI!"

# 6. Search across all messages
beeper search --query "project deadline" --output markdown

Now you're ready to automate your Beeper workflows!