build-in-public-bot/README.npm.md

AI-powered CLI bot for automating build-in-public tweets with code screenshots

# Build-in-Public Bot 🚀

> **The Ultimate AI-Powered Developer's Companion for Building in Public**

Transform your development workflow into engaging social media content with beautiful code screenshots, intelligent tweet generation, and seamless automation.

[![npm version](https://badge.fury.io/js/build-in-public-bot.svg)](https://badge.fury.io/js/build-in-public-bot)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Node.js Version](https://img.shields.io/node/v/build-in-public-bot.svg)](https://nodejs.org)

## ✨ Key Features

- 🤖 **AI-Powered Tweet Generation** - Smart, contextual content creation
- 📸 **Stunning Code Screenshots** - 5 professional themes (Cyberpunk, Matrix, Wave, Halftone, Disruptor)
- 🖥️ **Terminal Capture** - Smart selections with annotations and arrows
- 🐦 **Twitter Integration** - Browser automation, no API keys needed
- 🔄 **Smart Automation** - Watch mode, git analysis, auto-posting
- 🎨 **Customizable Themes** - Perfect for showcasing your best work

## 🚀 Quick Start

```bash
# Install globally
npm install -g build-in-public-bot

# Setup (30 seconds)
bip init                # Initialize configuration
bip setup browser       # Twitter authentication
bip setup api          # AI configuration
bip auto-alias         # Helpful shortcuts

# Your first tweet
bip post "Just shipped my new feature!"
```

## 🔥 Core Commands

```bash
# Generate and post tweets
bip post "Working on authentication system"

# Share beautiful code screenshots
bip code app.js "Clean implementation" --theme cyberpunk

# Capture terminal with annotations
bip terminal --select-errors --theme matrix

# Create drafts (test without posting)
bip draft "New feature preview"

# Watch for changes and suggest tweets
bip watch src/
```

## 🎨 Screenshot Themes

- **Cyberpunk** - Neon futuristic aesthetic
- **Matrix** - Classic green-on-black terminal
- **Wave Gradient** - Smooth, professional gradients
- **Halftone** - Retro dot pattern effect
- **Disruptor** - Bold, high-contrast design

## ⚙️ Configuration

Supports multiple AI providers:
- **OpenRouter** (recommended) - Access to multiple models
- **OpenAI** - GPT-3.5/4 models
- **Anthropic** - Claude models

```bash
# Set up API keys
export OPENROUTER_API_KEY="sk-or-..."
export OPENAI_API_KEY="sk-..."
export ANTHROPIC_API_KEY="sk-ant-..."

# Or configure interactively
bip setup api
```

## 🔧 Advanced Features

### Smart Automation
```bash
bip watch src/          # Monitor file changes
bip auto start          # Git-based auto-posting
```

### Terminal Annotations
```bash
bip terminal --arrow "5:1:8:10:Key fix here"
bip terminal --box "1-5:0-80" --note "3:Important"
```

### Style Customization
```bash
bip style --tone professional --emojis moderate
```

## 📚 Documentation

- [Complete Documentation](https://github.com/codyrobertson/build-in-public-bot#readme)
- [Getting Started Guide](https://github.com/codyrobertson/build-in-public-bot/blob/main/GETTING_STARTED.md)
- [API Documentation](https://github.com/codyrobertson/build-in-public-bot/blob/main/API.md)

## 🚨 Requirements

- **Node.js 16+**
- **Chrome browser** (for Twitter authentication)
- **AI API key** (OpenAI, Anthropic, or OpenRouter)

## 🔧 Troubleshooting

```bash
# System health check
bip doctor

# Re-authenticate Twitter
bip setup browser

# Check configuration
bip setup status
```

## 🎯 Real-World Examples

### Daily Development
```bash
# Morning standup
bip post "Starting work on user authentication"

# Share progress
bip code src/auth.ts "JWT implementation complete"

# End of day
bip post "Wrapped up auth! Tomorrow: user profiles"
```

### Feature Launches
```bash
# Build anticipation
bip draft "Getting ready to launch..."

# Show the code
bip code src/feature.js "The core implementation"

# Celebrate success
bip post "🚀 Feature is live! Check it out at https://myapp.com"
```

## 🏆 Why Developers Love It

- **3x More Engagement** - Visual content performs better
- **Zero API Complexity** - Browser automation handles everything
- **Beautiful by Default** - Professional themes out of the box
- **Smart Automation** - Suggests content based on your work
- **Privacy Focused** - All data stays on your machine

## 📈 Perfect For

- **Solo Developers** - Share your coding journey
- **Startup Teams** - Build community around your product
- **Open Source** - Document contributions and progress
- **Content Creators** - Generate engaging technical content
- **Students** - Share learning progress (#100DaysOfCode)

## 🤝 Community

- 🐦 [Twitter](https://twitter.com/buildinpublicbot)
- 📧 [Issues](https://github.com/codyrobertson/build-in-public-bot/issues)
- 💬 [Discussions](https://github.com/codyrobertson/build-in-public-bot/discussions)

## 📄 License

MIT - See [LICENSE](https://github.com/codyrobertson/build-in-public-bot/blob/main/LICENSE) for details.

---

**Ready to build in public?** 

```bash
npm install -g build-in-public-bot
bip init
```

Start sharing your journey today! 🚀

*Made with ❤️ by developers, for developers who build in public.*