Skip to content

Commit c4b95a8

Browse files
committed
Rename project from beeper-cli to beeper-api-cli
- Update module path to github.com/nerveband/beeper-api-cli - Rename config directory to ~/.beeper-api-cli - Update binary names to beeper-api-{platform} - Add Inspiration & Related Tools section - Credit KrauseFx/beeper-cli and salmonumbrella/beeper-cli - Update all documentation and references
1 parent c880a12 commit c4b95a8

19 files changed

Lines changed: 64 additions & 59 deletions

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Thank you for considering contributing to Beeper CLI.
55
## Getting Started
66

77
1. Fork the repository
8-
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/beeper-cli`
8+
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/beeper-api-cli`
99
3. Create a feature branch: `git checkout -b feature/your-feature`
1010
4. Make your changes
1111
5. Test thoroughly: `go test ./...`

IMPLEMENTATION_NOTES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Internal documentation for developers working on Beeper CLI.
3434
## Project Structure Rationale
3535

3636
```
37-
beeper-cli/
37+
beeper-api-cli/
3838
├── main.go # Minimal entry point
3939
├── cmd/ # Command implementations
4040
├── internal/ # Private packages

PROJECT_SUMMARY.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ A cross-platform command-line interface for the Beeper Desktop API, built in Go.
66

77
## Repository
88

9-
**GitHub**: https://github.com/nerveband/beeper-cli
9+
**GitHub**: https://github.com/nerveband/beeper-api-cli
1010

11-
**Latest Release**: v0.1.0 - https://github.com/nerveband/beeper-cli/releases/tag/v0.1.0
11+
**Latest Release**: v0.1.0 - https://github.com/nerveband/beeper-api-cli/releases/tag/v0.1.0
1212

1313
## Architecture
1414

@@ -20,7 +20,7 @@ A cross-platform command-line interface for the Beeper Desktop API, built in Go.
2020

2121
### Project Structure
2222
```
23-
beeper-cli/
23+
beeper-api-cli/
2424
├── main.go # Entry point
2525
├── cmd/ # CLI commands
2626
│ ├── root.go # Root command
@@ -120,8 +120,8 @@ beeper messages list --chat-id CHAT --output markdown > messages.md
120120

121121
### Build from Source
122122
```bash
123-
git clone https://github.com/nerveband/beeper-cli
124-
cd beeper-cli
123+
git clone https://github.com/nerveband/beeper-api-cli
124+
cd beeper-api-cli
125125
go build -o beeper .
126126
```
127127

@@ -162,28 +162,28 @@ git push origin v0.2.0
162162
## Installation
163163

164164
### Pre-built Binaries
165-
Download from: https://github.com/nerveband/beeper-cli/releases/latest
165+
Download from: https://github.com/nerveband/beeper-api-cli/releases/latest
166166

167167
```bash
168168
# macOS (arm64)
169-
curl -L https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-darwin-arm64 -o beeper
169+
curl -L https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-darwin-arm64 -o beeper
170170
chmod +x beeper
171171
sudo mv beeper /usr/local/bin/
172172

173173
# Linux (amd64)
174-
curl -L https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-linux-amd64 -o beeper
174+
curl -L https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-linux-amd64 -o beeper
175175
chmod +x beeper
176176
sudo mv beeper /usr/local/bin/
177177
```
178178

179179
### From Source
180180
```bash
181-
go install github.com/nerveband/beeper-cli@latest
181+
go install github.com/nerveband/beeper-api-cli@latest
182182
```
183183

184184
## Configuration
185185

186-
Default config location: `~/.beeper-cli/config.yaml`
186+
Default config location: `~/.beeper-api-cli/config.yaml`
187187

188188
```yaml
189189
api_url: http://localhost:39867
@@ -231,9 +231,9 @@ See [CONTRIBUTING.md](CONTRIBUTING.md)
231231
232232
## Links
233233
234-
- **Repository**: https://github.com/nerveband/beeper-cli
235-
- **Issues**: https://github.com/nerveband/beeper-cli/issues
236-
- **Releases**: https://github.com/nerveband/beeper-cli/releases
234+
- **Repository**: https://github.com/nerveband/beeper-api-cli
235+
- **Issues**: https://github.com/nerveband/beeper-api-cli/issues
236+
- **Releases**: https://github.com/nerveband/beeper-api-cli/releases
237237
- **Beeper Desktop**: https://www.beeper.com/
238238
239239
## Credits

QUICKSTART.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,32 +13,32 @@ Get up and running with Beeper CLI in under 5 minutes.
1313

1414
**macOS (Apple Silicon)**
1515
```bash
16-
curl -L https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-darwin-arm64 -o beeper
16+
curl -L https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-api-darwin-arm64 -o beeper
1717
chmod +x beeper
1818
sudo mv beeper /usr/local/bin/
1919
```
2020

2121
**macOS (Intel)**
2222
```bash
23-
curl -L https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-darwin-amd64 -o beeper
23+
curl -L https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-api-darwin-amd64 -o beeper
2424
chmod +x beeper
2525
sudo mv beeper /usr/local/bin/
2626
```
2727

2828
**Linux (amd64)**
2929
```bash
30-
curl -L https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-linux-amd64 -o beeper
30+
curl -L https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-api-linux-amd64 -o beeper
3131
chmod +x beeper
3232
sudo mv beeper /usr/local/bin/
3333
```
3434

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

3838
### Option B: Build from Source
3939
```bash
40-
git clone https://github.com/nerveband/beeper-cli
41-
cd beeper-cli
40+
git clone https://github.com/nerveband/beeper-api-cli
41+
cd beeper-api-cli
4242
go build -o beeper .
4343
sudo mv beeper /usr/local/bin/
4444
```
@@ -135,13 +135,13 @@ beeper chats list --output text
135135
### Commands not working
136136
- Verify installation: `beeper --help`
137137
- Check you're using the latest version
138-
- Open an issue: https://github.com/nerveband/beeper-cli/issues
138+
- Open an issue: https://github.com/nerveband/beeper-api-cli/issues
139139

140140
## Getting Help
141141

142142
- **Command Help**: `beeper [command] --help`
143-
- **GitHub Issues**: https://github.com/nerveband/beeper-cli/issues
144-
- **Documentation**: https://github.com/nerveband/beeper-cli
143+
- **GitHub Issues**: https://github.com/nerveband/beeper-api-cli/issues
144+
- **Documentation**: https://github.com/nerveband/beeper-api-cli
145145

146146
## Example Workflow
147147

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Beeper CLI
1+
# Beeper API CLI
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

@@ -21,17 +21,17 @@ While existing tools read the Beeper SQLite database directly, this CLI interfac
2121
```bash
2222
# Download latest release for your platform
2323
# macOS (arm64)
24-
curl -L https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-darwin-arm64 -o beeper
24+
curl -L https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-api-darwin-arm64 -o beeper
2525
chmod +x beeper
2626
sudo mv beeper /usr/local/bin/
2727

2828
# Linux (amd64)
29-
curl -L https://github.com/nerveband/beeper-cli/releases/latest/download/beeper-linux-amd64 -o beeper
29+
curl -L https://github.com/nerveband/beeper-api-cli/releases/latest/download/beeper-api-linux-amd64 -o beeper
3030
chmod +x beeper
3131
sudo mv beeper /usr/local/bin/
3232

3333
# Or build from source
34-
go install github.com/nerveband/beeper-cli@latest
34+
go install github.com/nerveband/beeper-api-cli@latest
3535
```
3636

3737
## Quick Start
@@ -58,7 +58,7 @@ beeper search --query "important meeting"
5858

5959
## Configuration
6060

61-
The CLI stores configuration in `~/.beeper-cli/config.yaml`:
61+
The CLI stores configuration in `~/.beeper-api-cli/config.yaml`:
6262

6363
```yaml
6464
api_url: http://localhost:39867
@@ -124,21 +124,26 @@ Built with Go for:
124124

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

127-
## Comparison with beeper-tools
127+
## Inspiration & Related Tools
128128

129-
The existing [beeper-tools](https://github.com/beeper/beeper-tools) provides read-only access via direct SQLite database queries. This CLI complements it by:
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:
130130

131-
- Using the HTTP API instead of direct database access
132-
- Supporting write operations (sending messages, reactions)
133-
- Providing structured output formats optimized for LLM consumption
134-
- Enabling real-time operations without database locks
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
135+
136+
### Other Beeper CLI Tools
137+
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
135140

136141
## Development
137142

138143
```bash
139144
# Clone repository
140-
git clone https://github.com/nerveband/beeper-cli
141-
cd beeper-cli
145+
git clone https://github.com/nerveband/beeper-api-cli
146+
cd beeper-api-cli
142147
143148
# Install dependencies
144149
go mod download

TEST_README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ go tool cover -html=coverage.out
169169
## Test Structure
170170

171171
```
172-
beeper-cli/
172+
beeper-api-cli/
173173
├── internal/
174174
│ ├── api/
175175
│ │ ├── client.go

build.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ set -e
44
VERSION=${VERSION:-dev}
55
OUTPUT_DIR="dist"
66

7-
echo "Building Beeper CLI ${VERSION}..."
7+
echo "Building Beeper API CLI ${VERSION}..."
88

99
mkdir -p ${OUTPUT_DIR}
1010

@@ -20,7 +20,7 @@ PLATFORMS=(
2020
for platform in "${PLATFORMS[@]}"; do
2121
OS=$(echo $platform | cut -d'/' -f1)
2222
ARCH=$(echo $platform | cut -d'/' -f2)
23-
OUTPUT_NAME="beeper-${OS}-${ARCH}"
23+
OUTPUT_NAME="beeper-api-${OS}-${ARCH}"
2424

2525
if [ "$OS" = "windows" ]; then
2626
OUTPUT_NAME="${OUTPUT_NAME}.exe"

cmd/chats.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import (
44
"fmt"
55

66
"github.com/spf13/cobra"
7-
"github.com/nerveband/beeper-cli/internal/api"
8-
"github.com/nerveband/beeper-cli/internal/output"
7+
"github.com/nerveband/beeper-api-cli/internal/api"
8+
"github.com/nerveband/beeper-api-cli/internal/output"
99
)
1010

1111
var chatsCmd = &cobra.Command{

cmd/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"fmt"
55

66
"github.com/spf13/cobra"
7-
"github.com/nerveband/beeper-cli/internal/config"
7+
"github.com/nerveband/beeper-api-cli/internal/config"
88
)
99

1010
var configCmd = &cobra.Command{

cmd/discover.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import (
44
"fmt"
55

66
"github.com/spf13/cobra"
7-
"github.com/nerveband/beeper-cli/internal/api"
8-
"github.com/nerveband/beeper-cli/internal/config"
7+
"github.com/nerveband/beeper-api-cli/internal/api"
8+
"github.com/nerveband/beeper-api-cli/internal/config"
99
)
1010

1111
var discoverCmd = &cobra.Command{

0 commit comments

Comments
 (0)