Skip to content

Commit 7239d6a

Browse files
committed
Add Quick Start guide and improve README navigation
1 parent cb0fe92 commit 7239d6a

2 files changed

Lines changed: 170 additions & 0 deletions

File tree

QUICKSTART.md

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
# Beeper CLI Quick Start
2+
3+
Get up and running with Beeper CLI in under 5 minutes.
4+
5+
## Prerequisites
6+
7+
- Beeper Desktop installed and running
8+
- Terminal access
9+
10+
## Step 1: Install
11+
12+
### Option A: Download Pre-built Binary (Recommended)
13+
14+
**macOS (Apple Silicon)**
15+
```bash
16+
curl -L https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-darwin-arm64 -o beeper
17+
chmod +x beeper
18+
sudo mv beeper /usr/local/bin/
19+
```
20+
21+
**macOS (Intel)**
22+
```bash
23+
curl -L https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-darwin-amd64 -o beeper
24+
chmod +x beeper
25+
sudo mv beeper /usr/local/bin/
26+
```
27+
28+
**Linux (amd64)**
29+
```bash
30+
curl -L https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-linux-amd64 -o beeper
31+
chmod +x beeper
32+
sudo mv beeper /usr/local/bin/
33+
```
34+
35+
**Windows**
36+
Download from: https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-windows-amd64.exe
37+
38+
### Option B: Build from Source
39+
```bash
40+
git clone https://github.com/nerveband/beeper-cli
41+
cd beeper-cli
42+
go build -o beeper .
43+
sudo mv beeper /usr/local/bin/
44+
```
45+
46+
## Step 2: Configure
47+
48+
Auto-discover your Beeper Desktop API:
49+
```bash
50+
beeper discover
51+
```
52+
53+
Expected output:
54+
```
55+
Discovering Beeper Desktop API...
56+
Found Beeper Desktop API at: http://localhost:39867
57+
Configuration saved successfully!
58+
```
59+
60+
**Manual Configuration** (if auto-discovery fails):
61+
```bash
62+
beeper config set-url http://localhost:39867
63+
```
64+
65+
## Step 3: Verify Installation
66+
67+
Check your configuration:
68+
```bash
69+
beeper config show
70+
```
71+
72+
Expected output:
73+
```
74+
API URL: http://localhost:39867
75+
Output Format: json
76+
```
77+
78+
## Step 4: List Your Chats
79+
80+
```bash
81+
beeper chats list
82+
```
83+
84+
You should see JSON output with all your Beeper conversations.
85+
86+
### Human-Readable Format
87+
```bash
88+
beeper chats list --output text
89+
```
90+
91+
## Step 5: Send Your First Message
92+
93+
1. **Get a chat ID** from the previous command
94+
2. **Send a message**:
95+
96+
```bash
97+
beeper send --chat-id YOUR_CHAT_ID --message "Hello from Beeper CLI!"
98+
```
99+
100+
## Common Commands
101+
102+
### List messages from a chat
103+
```bash
104+
beeper messages list --chat-id CHAT_ID --limit 20
105+
```
106+
107+
### Search for messages
108+
```bash
109+
beeper search --query "important meeting"
110+
```
111+
112+
### Change output format
113+
```bash
114+
beeper chats list --output markdown
115+
beeper chats list --output text
116+
```
117+
118+
## Next Steps
119+
120+
- **LLM Integration**: See `examples/llm-integration.sh` for advanced usage
121+
- **Full Documentation**: Read `README.md` for complete command reference
122+
- **API Details**: Check `API.md` for endpoint documentation
123+
124+
## Troubleshooting
125+
126+
### "Could not auto-discover Beeper Desktop API"
127+
- Ensure Beeper Desktop is running
128+
- Check if port 39867 is accessible: `curl http://localhost:39867/health`
129+
- Try manual configuration: `beeper config set-url http://localhost:PORT`
130+
131+
### "API error (status 404)"
132+
- Verify Beeper Desktop API server is enabled in settings
133+
- Check the API URL is correct: `beeper config show`
134+
135+
### Commands not working
136+
- Verify installation: `beeper --help`
137+
- Check you're using the latest version
138+
- Open an issue: https://github.com/nerveband/beeper-cli/issues
139+
140+
## Getting Help
141+
142+
- **Command Help**: `beeper [command] --help`
143+
- **GitHub Issues**: https://github.com/nerveband/beeper-cli/issues
144+
- **Documentation**: https://github.com/nerveband/beeper-cli
145+
146+
## Example Workflow
147+
148+
```bash
149+
# 1. Setup
150+
beeper discover
151+
152+
# 2. Explore your chats
153+
beeper chats list --output text
154+
155+
# 3. Get chat ID you want to message
156+
CHAT_ID="your_chat_id_here"
157+
158+
# 4. Read recent messages
159+
beeper messages list --chat-id $CHAT_ID --limit 10
160+
161+
# 5. Send a message
162+
beeper send --chat-id $CHAT_ID --message "Testing Beeper CLI!"
163+
164+
# 6. Search across all messages
165+
beeper search --query "project deadline" --output markdown
166+
```
167+
168+
Now you're ready to automate your Beeper workflows!

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A cross-platform command-line interface for the Beeper Desktop API. Built for programmatic access to Beeper conversations with LLM-friendly output formats.
44

5+
🚀 **[Quick Start Guide](QUICKSTART.md)** | 📚 **[API Documentation](API.md)** | 🔧 **[Examples](examples/)**
6+
57
## Purpose
68

79
While existing tools read the Beeper SQLite database directly, this CLI interfaces with the Beeper Desktop HTTP API to provide both read and write capabilities. This enables sending messages, managing conversations, and full bidirectional communication through Beeper's unified chat platform.

0 commit comments

Comments
 (0)