https://github.com/polka-codes/polka-codes
https://github.com/polka-codes/polka-codes
ai bun coding-assistant typescript
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/polka-codes/polka-codes
- Owner: polka-codes
- License: agpl-3.0
- Created: 2025-01-08T05:53:41.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-04-28T04:12:17.000Z (5 months ago)
- Last Synced: 2025-04-28T04:31:53.815Z (5 months ago)
- Topics: ai, bun, coding-assistant, typescript
- Language: TypeScript
- Homepage: https://polka.codes
- Size: 1010 KB
- Stars: 16
- Watchers: 1
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-AI-driven-development - Polka Codes - a powerful TypeScript-based AI coding assistant framework that helps developers write, improve, and maintain code through natural language interactions. (Frameworks & Libraries / Copilot Extensions & Alternatives)
README
# Polka Codes - AI-Powered Coding Assistant
[](LICENSE)
[](https://bun.sh)
[](https://www.typescriptlang.org)
> **Warning**
> This project is still in very early stages of development. Please use with caution as APIs and features may change frequently.
Polka Codes is a powerful TypeScript-based AI coding assistant framework that helps developers write, improve, and maintain code through natural language interactions. It features a multi-agent system, a command-line interface, and seamless GitHub integration to streamline your development workflow.
## Quick Start
### Installation
```bash
# Install globally using npm
npm install -g @polka-codes/cli
# Or run directly using npx
npx @polka-codes/cli "your task description"
```
### Basic Usage
```bash
# Create a new project
polka create my-project
# Initialize configuration
polka init
# Run a task
polka "improve README.md"
# Start an interactive chat session
polka
# Get help
polka --help
```
For more information, see the [CLI README](packages/cli/README.md).
## Features
- 🎯 **Project Scaffolding**: Easily create new projects with the `create` command.
- 🔧 **Simple Setup**: Quickly initialize your project configuration with `init`.
- 🤖 **Multiple AI Providers**: Supports DeepSeek (recommended), Anthropic Claude, Ollama, and OpenRouter.
- 🤝 **Multi-Agent System**: Specialized AI agents collaborate on complex tasks:
- **Architect Agent**: Handles system design and high-level planning.
- **Coder Agent**: Focuses on implementation, coding, and maintenance.
- **Analyzer Agent**: Analyzes code and project structure.
- **Code Fixer Agent**: Fixes bugs and addresses issues.
- 🧠 **Knowledge Management**: Automatically captures and maintains knowledge about your codebase in `knowledge.ai.yml` files, ensuring agents have context.
- 💻 **Interactive CLI**: A powerful command-line interface for task execution and interactive chat.
- 🔄 **GitHub Integration**: A GitHub Action that allows you to run Polka Codes by mentioning it in pull requests and issues.
- 📦 **Extensible Architecture**: A modular design that allows for adding new AI providers, tools, and agents.
- ⚡ **Type Safety**: Fully typed with TypeScript for a better developer experience.
- 🧪 **Thoroughly Tested**: Comprehensive test suite using `bun:test` with snapshot testing.
## Project Structure
The project is organized as a monorepo with the following packages:
| Package | Description |
|---------|-------------|
| [`core`](/packages/core) | Core AI services, agent implementations, and tooling. |
| [`cli`](/packages/cli) | Command-line interface for interacting with AI services. |
| [`cli-shared`](/packages/cli-shared) | Shared utilities and types for CLI packages. |
| [`github`](/packages/github) | GitHub integration, including the GitHub Action. |
| [`runner`](/packages/runner) | Service for running agents and managing tasks. |
## Getting Started
### Prerequisites
- [Bun](https://bun.sh/) (v1.0.0 or higher)
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation) (required for the file search tool)
### Development Setup
```bash
# Clone the repository
git clone https://github.com/polka-codes/polka-codes.git
cd polka-codes
# Install dependencies
bun install
```
### Available Scripts
- `bun test`: Run tests across all packages and update snapshots.
- `bun typecheck`: Run type checking.
- `bun fix --unsafe`: Fix linting and formatting issues.
## Configuration
A [`.polkacodes.yml`](.polkacodes.yml) configuration file can be used to customize the behavior of polka-codes. An example configuration file is provided in the repository as [`example.polkacodes.yml`](example.polkacodes.yml).
For detailed configuration options, refer to the example file, which includes comprehensive comments for each setting.
## Environment Variables
The following environment variables can be used to configure Polka Codes. Note that command line options take precedence over environment variables, which in turn take precedence over the configuration file.
| Variable | Description |
|----------|-------------|
| `POLKA_API_PROVIDER` | Specify the default AI service provider. |
| `POLKA_MODEL` | Specify the default AI model to use. |
| `POLKA_API_KEY` | Default API key for the selected provider. |
| `POLKA_BUDGET` | Set the budget limit for AI service usage (defaults to 1000). |
| `ANTHROPIC_API_KEY` | API key for Anthropic Claude service. |
| `OPENROUTER_API_KEY` | API key for OpenRouter service. |
| `DEEPSEEK_API_KEY` | API key for DeepSeek service. |
## License
This project is licensed under the [AGPL-3.0 License](LICENSE).
## Credits
This project is heavily inspired by the [Cline](https://github.com/cline/cline) project.
---
*Generated by polka.codes*