Skip to main content

Open-source terminal AI coding assistant

Project description

OpenLaoKe

Open-source terminal AI coding assistant.

Features

  • Interactive REPL with rich terminal UI
  • Multi-Provider Support - Anthropic, OpenAI, Ollama, LM Studio, and custom endpoints
  • Tool System with 9 built-in tools:
    • Bash - Execute shell commands with streaming output
    • Read - Read file contents with line range support
    • Write - Create/overwrite files
    • Edit - Targeted find-and-replace file edits with diff output
    • Glob - Fast file pattern matching (respects .gitignore)
    • Grep - Regex search across files with multiple output modes
    • Agent - Spawn sub-agents for parallel work
    • Taskkill - Kill running tasks
    • NotebookWrite - Write Jupyter notebook cells
  • MCP Support - Connect to external MCP tool servers
  • Permission System - Three modes: default, auto, bypass
  • Session Persistence - Auto-save and resume sessions
  • Cost Tracking - Real-time token usage and cost display
  • Slash Commands - 11 built-in commands (/help, /model, /cost, /compact, etc.)
  • Hook System - Extensible pre/post hooks for tool and API calls
  • Proxy Support - No proxy, system proxy, or custom proxy

Installation

# Clone and install
cd OpenLaoKe
pip install -e .

# Or with uv (recommended)
uv pip install -e .

Usage

# First run (shows configuration wizard)
openlaoke

# Reconfigure
openlaoke --config

# Non-interactive mode
openlaoke "Write a Python script that sorts a list"

# With options
openlaoke -m gpt-4o -p auto
openlaoke --provider ollama -m llama3.2
openlaoke --proxy http://127.0.0.1:7890
openlaoke --cwd /path/to/project

Supported Providers

Provider Type API Key Required
Anthropic Cloud Yes
OpenAI Cloud Yes
Ollama Local No
LM Studio Local No
OpenAI-Compatible Custom Optional

Environment Variables

Variable Description
ANTHROPIC_API_KEY Anthropic API key
OPENAI_API_KEY OpenAI API key
OPENLAOKE_MODEL Default model

Slash Commands

Command Description
/help Show available commands
/exit Exit OpenLaoKe
/clear Clear screen and conversation
/model [name] Show or change model
/permission [mode] Change permission mode
/compact Compact conversation
/cost Show session cost and usage
/cwd [path] Show or change working directory
/resume Resume last session
/commands Show example commands
/settings Show current settings

Architecture

openlaoke/
├── core/           # Core systems
│   ├── state.py    # Centralized state management
│   ├── tool.py     # Tool base class and registry
│   ├── task.py     # Task lifecycle management
│   ├── multi_provider_api.py  # Multi-provider API client
│   ├── repl.py     # REPL interaction loop
│   ├── config_wizard.py  # Configuration wizard
│   └── ...
├── tools/          # Tool implementations
├── commands/       # Slash commands
├── services/       # External services (MCP)
├── components/     # UI components (TUI)
├── types/          # Type definitions
└── utils/          # Utilities

Development

# Install dev dependencies
pip install -e ".[dev]"

# Run linter
ruff check .

# Run tests
pytest

# Build package
python -m build

Configuration

User config is stored at ~/.openlaoke/config.json. You can edit it directly or use /settings in the REPL.

License

GPLv3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openlaoke-0.1.9.tar.gz (340.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openlaoke-0.1.9-py3-none-any.whl (370.6 kB view details)

Uploaded Python 3

File details

Details for the file openlaoke-0.1.9.tar.gz.

File metadata

  • Download URL: openlaoke-0.1.9.tar.gz
  • Upload date:
  • Size: 340.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for openlaoke-0.1.9.tar.gz
Algorithm Hash digest
SHA256 5cc001a207d15ba447144880bbaac76bd25187a4361709a0066d5a9580819c9a
MD5 18ae830cee2d44f9943b3e8c30eab9ef
BLAKE2b-256 12f849ad940e02a546b3b5deea6e039035b5fc8408bac168463e0e2a959c899d

See more details on using hashes here.

File details

Details for the file openlaoke-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: openlaoke-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 370.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for openlaoke-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 c52b4097375d62a24757886627fddace62c029dedade3289fb0fcc6fc7ada170
MD5 6417659dd96b89dfaa718c9c65e459a4
BLAKE2b-256 a11f9a120c1f939c82817d7be177c72bb9f395d83c82f4026e70b4e3e01413c5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page