codowave 0.1.1 → 0.1.2

package/README.md

@@ -1,53 +1,253 @@
-# Codowave CLI
+# 🤖 Codowave CLI
 
-AI-powered coding agent for your GitHub repos.
+<p align="center">
 
-## Installation
+[![npm version](https://img.shields.io/npm/v/codowave)](https://www.npmjs.com/package/codowave)
+[![npm downloads](https://img.shields.io/npm/dm/codowave)](https://www.npmjs.com/package/codowave)
+[![License](https://img.shields.io/github/license/CodowaveAI/Codowave)](LICENSE)
+[![Stars](https://img.shields.io/github/stars/CodowaveAI/Codowave)](https://github.com/CodowaveAI/Codowave/stargazers)
+[![Forks](https://img.shields.io/github/forks/CodowaveAI/Codowave)](https://github.com/CodowaveAI/Codowave/network)
+[![Issues](https://img.shields.io/github/issues/CodowaveAI/Codowave)](https://github.com/CodowaveAI/Codowave/issues)
+[![CI](https://img.shields.io/github/actions/workflow/status/CodowaveAI/Codowave/ci)](https://github.com/CodowaveAI/Codowave/actions)
+[![Last Commit](https://img.shields.io/github/last-commit/CodowaveAI/Codowave)](https://github.com/CodowaveAI/Codowave/commits/main)
+
+</p>
+
+> **Self-hosted AI coding assistant that works on your servers, your rules**
+
+Codowave is an autonomous AI agent that automates your GitHub workflow. It reads issues, plans solutions, writes code, runs tests, and creates PRs — automatically.
+
+## ✨ Features
+
+- **🤖 Autonomous Issue Resolution** — AI reads issues, codes fixes, and opens PRs
+- **🔒 Self-Hosted** — Runs on your infrastructure. Your code never leaves your servers
+- **🔗 GitHub Native** — Deep integration with Issues, PRs, and Actions
+- **🧪 Auto-Testing** — Runs tests automatically before creating PRs
+- **⚡ Fast Setup** — Get started in under 5 minutes
+- **🔌 Extensible** — Add custom skills and workflows
+- **📊 Real-time Monitoring** — Track runs with status and logs commands
+
+## 🚀 Quick Start
+
+### Installation
 
 ```bash
+# Install globally with npm
 npm install -g codowave
+
+# Or with pnpm
+pnpm add -g codowave
+
+# Or with yarn
+yarn global add codowave
 ```
 
-## Development
+### Initialize
 
 ```bash
-# Install dependencies
-pnpm install
+# Initialize Codowave with your GitHub App
+codowave init
+```
+
+This wizard will:
+1. Connect your GitHub account
+2. Select repositories to automate
+3. Configure your AI provider (OpenAI, Anthropic, Ollama, etc.)
+4. Start processing issues automatically!
+
+### Process an Issue
+
+```bash
+# Process an issue by URL
+codowave run https://github.com/owner/repo/issues/123
+
+# Or by issue number (if in correct repo)
+codowave run 123
+
+# Specify a different repository
+codowave run 456 --repo owner/repo
+```
+
+### Check Status
+
+```bash
+# View overall status
+codowave status
+
+# Check a specific run
+codowave status --run-id abc123
+```
+
+### View Logs
+
+```bash
+# View logs for a run
+codowave logs --run-id abc123
+
+# Stream logs in real-time
+codowave logs --run-id abc123 --follow
+```
+
+## 📖 Commands
+
+| Command | Description |
+|---------|-------------|
+| `codowave init` | Initialize Codowave with your GitHub App |
+| `codowave run <issue>` | Process an issue (URL or number) |
+| `codowave status` | Check overall or run-specific status |
+| `codowave logs` | View logs for a run |
+| `codowave --help` | Show help |
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `-V, --version` | Show version number |
+| `-h, --help` | Show help |
 
-# Build the CLI
-pnpm --filter codowave build
+## ⚙️ Configuration
 
-# Run in development mode
-pnpm --filter codowave dev
+### Environment Variables
+
+```bash
+# Required for GitHub operations
+GITHUB_APP_ID=your_app_id
+GITHUB_APP_PRIVATE_KEY=your_private_key
+GITHUB_WEBHOOK_SECRET=your_secret
+
+# AI Provider (choose one)
+OPENAI_API_KEY=sk-...
+ANTHROPIC_API_KEY=sk-ant-...
+OLLAMA_BASE_URL=http://localhost:11434
+MINIMAX_API_KEY=your_key
 ```
 
-## Publishing to npm
+### Configuration File
+
+Create `codowave.config.yaml` in your project:
+
+```yaml
+github:
+  app_id: your_app_id
+  private_key: ./private-key.pem
+
+ai:
+  provider: openai  # openai, anthropic, ollama, minimax
+  model: gpt-4
+
+autopilot:
+  enabled: true
+  max_retries: 3
+  auto_merge: true
+```
+
+## 🏗️ Architecture
+
+```
+┌─────────────────────────────────────────────────────────┐
+│                    Codowave CLI                        │
+└─────────────────────────────────────────────────────────┘
+                          │
+                          ▼
+┌─────────────────────────────────────────────────────────┐
+│                   @codowave/core                        │
+│  ┌──────────┐ ┌──────────┐ ┌──────────┐            │
+│  │ Context  │ │ Planner  │ │  Coder   │            │
+│  │ Builder  │ │    AI    │ │    AI    │            │
+│  └──────────┘ └──────────┘ └──────────┘            │
+│  ┌──────────┐ ┌──────────┐                          │
+│  │  Test   │ │PR Creator│                          │
+│  │ Runner  │ │          │                          │
+│  └──────────┘ └──────────┘                          │
+└─────────────────────────────────────────────────────────┘
+                          │
+                          ▼
+┌─────────────────────────────────────────────────────────┐
+│                   GitHub API                           │
+│         Issues ←→ PRs ←→ Actions ←→ Webhooks          │
+└─────────────────────────────────────────────────────────┘
+```
+
+## 🔐 Security
+
+- **Self-hosted** — Your code never leaves your servers
+- **GitHub App** — Secure OAuth-based authentication
+- **No data retention** — Processing is ephemeral
+- **Audit logging** — Full trail of all operations
+
+## 🤖 How It Works
+
+1. **Issue Received** → Agent reads issue description
+2. **Planning** → AI analyzes code, creates implementation plan
+3. **Approval** → (Optional) Human reviews plan
+4. **Coding** → Agent implements the fix
+5. **Testing** → Runs existing tests, adds new tests
+6. **PR Created** → Opens pull request with changes
+7. **Auto-Merged** → When CI passes, PR auto-merges
+
+## 📦 Packages
+
+This monorepo contains:
 
-This package is published to npm using GitHub Actions. The workflow is defined in `.github/workflows/npm-publish.yml`.
+| Package | Version | Description |
+|---------|---------|-------------|
+| `codowave` | ![npm](https://img.shields.io/npm/v/codowave) | CLI tool |
+| `@codowave/core` | ![npm](https://img.shields.io/npm/v/@codowave/core) | Core SDK |
 
-### Publishing a new version
+## 🛠️ Development
 
-**Option 1: Push a tag**
 ```bash
-# Create a tag with the version
-git tag cli/v0.1.0
-git push origin cli/v0.1.0
+# Clone the repository
+git clone https://github.com/CodowaveAI/Codowave.git
+cd Codowave
+
+# Install dependencies
+pnpm install
+
+# Build all packages
+pnpm build
+
+# Run tests
+pnpm test
+
+# TypeScript check
+pnpm typecheck
+```
+
+### Running in Docker
+
+```bash
+# Build the CLI Docker image
+docker build -t codowave-cli ./packages/cli
+
+# Run
+docker run --rm codowave-cli --help
 ```
 
-**Option 2: Manual workflow dispatch**
-1. Go to [Actions > Publish CLI to npm](https://github.com/CodowaveAI/Codowave/actions/workflows/npm-publish.yml)
-2. Click "Run workflow"
-3. Enter the version bump (patch, minor, major) or specific version
-4. Click "Run workflow"
+## 📚 Documentation
+
+- [Getting Started](https://codowave.com/docs)
+- [Configuration](https://codowave.com/docs/config)
+- [AI Providers](https://codowave.com/docs/ai-providers)
+- [API Reference](https://codowave.com/docs/api)
+
+## 🙏 Acknowledgments
+
+- [OpenClaw](https://github.com/openclaw/openclaw) — AI agent framework
+- [MCP](https://modelcontextprotocol.io) — Model Context Protocol
+- [AI SDK](https://sdk.vercel.ai) — Vercel AI SDK
+
+## 📄 License
+
+MIT License — see [LICENSE](./LICENSE) for details.
 
-### Required secrets
+---
 
-To publish to npm, you need to set up the following secrets in your repository:
+<p align="center">
 
-1. **NPM_TOKEN**: An npm access token with publish permissions
-   - Create at: https://www.npmjs.com/settings/<your-username>/tokens
-   - Add to: https://github.com/CodowaveAI/Codowave/settings/secrets/actions
+**Built with 🔥 by [Codowave](https://codowave.com)**  
+**Contributions welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md)**
 
-## License
+[![Star us on GitHub](https://img.shields.io/github/stars/CodowaveAI/Codowave?style=social)](https://github.com/CodowaveAI/Codowave/stargazers)
 
-MIT
+</p>