Skip to content

Commit 4e0b63f

Browse files
committed
Add philosophy section and tool comparison guide
- Explain design goals: simplicity, minimal dependencies, API-first - Add 'Choosing the Right Tool' section comparing all Beeper CLIs - Highlight strengths of each tool to help users pick the best fit - Encourage users to explore salmonumbrella/beeper-cli for advanced features
1 parent c4b95a8 commit 4e0b63f

1 file changed

Lines changed: 51 additions & 10 deletions

File tree

README.md

Lines changed: 51 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -124,19 +124,60 @@ Built with Go for:
124124

125125
Uses Cobra for CLI framework and Viper for configuration management.
126126

127-
## Inspiration & Related Tools
128-
129-
This project was inspired by [KrauseFx/beeper-cli](https://github.com/KrauseFx/beeper-cli), a read-only tool that queries the Beeper SQLite database directly. While that tool provides excellent read-only functionality, beeper-api-cli takes a different approach:
127+
## Philosophy & Design Goals
128+
129+
**beeper-api-cli** is designed for simplicity and minimal dependencies:
130+
131+
- **Pure API approach** - No SQLite dependencies, no keyring requirements
132+
- **Simple authentication** - Manual token configuration (no OAuth flow)
133+
- **Focused feature set** - Core read/write operations for programmatic access
134+
- **LLM-friendly** - JSON/text/markdown output optimized for AI agents
135+
- **Single binary** - Easy cross-compilation and distribution
136+
137+
This makes it ideal for:
138+
- CI/CD pipelines and automation scripts
139+
- LLM/AI agent integrations
140+
- Environments where you want minimal dependencies
141+
- Quick setup without browser auth flows
142+
143+
## Choosing the Right Tool
144+
145+
Different Beeper CLI tools have different strengths. **Use the best tool for your use case!**
146+
147+
### [salmonumbrella/beeper-cli](https://github.com/salmonumbrella/beeper-cli) 🌟
148+
**Full-featured terminal client with desktop integration**
149+
- OAuth browser authentication with keyring storage
150+
- Real-time message streaming (tail/follow mode)
151+
- Desktop control (focus window, navigate chats, pre-fill drafts)
152+
- Advanced features: reminders, bulk archive, inbox view
153+
- DB backend for faster local search
154+
- Template output and JQ integration
155+
156+
**Best for:** Interactive terminal use, power users, desktop integration
157+
158+
### [KrauseFx/beeper-cli](https://github.com/KrauseFx/beeper-cli) 📖
159+
**Read-only SQLite access** (original inspiration for this project)
160+
- Direct database queries
161+
- No API dependencies
162+
163+
**Best for:** Quick local reads, offline access
164+
165+
### beeper-api-cli (this tool) 🚀
166+
**Lightweight API client for automation**
167+
- Pure HTTP API (no SQLite, no keyring)
168+
- Write operations (send, edit, react, delete)
169+
- Simple manual token auth
170+
- LLM-optimized JSON output
171+
- Minimal dependencies
130172

131-
- **API-based**: Uses the Beeper Desktop HTTP API instead of direct database access
132-
- **Read & Write**: Supports full bidirectional communication (sending messages, reactions, edits)
133-
- **LLM-Optimized**: Structured output formats designed for AI agent integration
134-
- **Real-time**: No database locks, enables concurrent operations
173+
**Best for:** Automation, CI/CD, LLM integration, simple deployments
135174

136-
### Other Beeper CLI Tools
175+
### [beeper-tools](https://github.com/beeper/beeper-tools) 🔧
176+
**Official Beeper utilities**
177+
- Direct SQLite access
178+
- Read-only operations
137179

138-
- **[salmonumbrella/beeper-cli](https://github.com/salmonumbrella/beeper-cli)** - Another SQLite-based CLI with different features
139-
- **[beeper-tools](https://github.com/beeper/beeper-tools)** - Official read-only tools via direct SQLite queries
180+
**Best for:** Official tools, basic SQLite queries
140181

141182
## Development
142183

0 commit comments

Comments
 (0)