Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/polka-codes/polka-codes


https://github.com/polka-codes/polka-codes

ai bun coding-assistant typescript

Last synced: about 6 hours ago
JSON representation

Awesome Lists containing this project

README

        

# Polka Codes - AI-Powered Coding Assistant

[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL%203.0-blue.svg)](LICENSE)
[![Bun Version](https://img.shields.io/badge/Bun-v1.0.0+-brightgreen)](https://bun.sh)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue)](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 provides:

- ๐Ÿš€ Core AI services with multiple provider support
- ๐Ÿ’ป Command-line interface for local development
- ๐Ÿค– GitHub Action integration for CI/CD pipelines
- ๐Ÿงฉ Extensible architecture for custom integrations

## 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
# Run some task
polka-codes "improve README.md"

# Start interactive chat session
polka-codes

# Get help
polka-codes --help

# Create config file
polka-codes config
```

For more information, see [cli README](packages/cli/README.md)

## Features

- ๐Ÿค– **Multiple AI Providers**: Supports DeepSeek (recommended), Anthropic Claude, and Ollama
- ๐Ÿ”ง **CLI Interface**: Interactive command-line tool with chat and task execution
- ๐Ÿ”„ **GitHub Action**: Seamless integration with CI/CD pipelines
- ๐Ÿ“ฆ **Extensible Architecture**: Modular design for adding new AI providers and tools
- โšก **Type Safety**: Fully typed with TypeScript for better developer experience
- ๐Ÿงช **Testing**: Comprehensive testing with bun:test and snapshot testing
- ๐Ÿ” **Code Analysis**: Built-in tools for code understanding and improvement

## 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 |
| [action](/packages/action) | GitHub Action integration for CI/CD pipelines |

## Getting Started

### Prerequisites

- [Bun](https://bun.sh/) (v1.0.0 or higher)

### Development Setup

```bash
# Clone and setup
git clone https://github.com/polka-codes/polka-codes.git
cd polka-codes
bun install

# Available scripts
bun run test # Run tests across all packages
bun run check # Run type checking and linting
bun run fix # Fix linting issues
```

## 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*