cloi  by gabrielchasukjin

CLI tool for local, private AI-assisted debugging

created 3 months ago
385 stars

Top 75.5% on sourcepulse

GitHubView on GitHub
Project Summary

Cloi is a local, context-aware debugging agent designed for developers who prefer working in the terminal and prioritize data privacy. It analyzes errors and can automatically suggest and apply code fixes directly within your project, all while keeping your code and data entirely on your machine.

How It Works

Cloi operates as a command-line interface (CLI) tool that integrates with your shell (Zsh, Fish, Bash). It leverages locally installed Ollama models for its AI capabilities, allowing users to select from various models like Phi-4. The agent can analyze runtime errors by capturing terminal commands and their output, storing this information in a log file. For Zsh users, it offers automatic terminal logging via shell hooks, capturing all commands and their output for detailed error analysis without re-running commands.

Quick Start & Requirements

  • Install globally: npm install -g @cloi-ai/cloi
  • Requirements: Node.js 14+, Python 3.6+, Zsh (recommended for full features), Ollama (automatically installed if needed).
  • Hardware: 8GB RAM minimum (16GB+ recommended), 10GB+ free storage.
  • OS: macOS (Big Sur 11.0+).
  • Setup: Navigate to your project directory and run cloi when an error occurs. Logging setup requires explicit permission and a terminal restart.

Highlighted Details

  • 100% local execution, no API keys required, ensuring code and data privacy.
  • Beta feature for automated, iterative error patching with LLMs.
  • Customizable model selection via /model command or --model flag, supporting locally installed Ollama models.
  • Automatic terminal output logging for Zsh users, capturing commands and output to ~/.cloi/terminal_output.log.
  • Integrates with Ollama's latest API for structured outputs, enabling more robust patches.

Maintenance & Community

  • Active development with recent patches addressing Ollama dependency updates and API integration.
  • Open to community contributions under GPL-3.0 license. Details available in CONTRIBUTING.md.

Licensing & Compatibility

  • License: GNU General Public License v3.0 (GPL-3.0).
  • Copyleft: Derivative works must also be distributed under GPL-3.0. Commercial use or linking with closed-source projects may be restricted due to the copyleft nature of GPL-3.0.

Limitations & Caveats

The project is in beta preview and may contain bugs. Terminal logging is currently limited to Zsh users. The macOS-only support and GPL-3.0 license may present adoption challenges for some users or organizations.

Health Check
Last commit

2 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
193 stars in the last 90 days

Explore Similar Projects

Starred by Jonathan Ragan-Kelley Jonathan Ragan-Kelley(Professor at MIT), Chip Huyen Chip Huyen(Author of AI Engineering, Designing Machine Learning Systems), and
2 more.

claudia by getAsterisk

6.2%
10k
GUI toolkit for Claude Code
created 1 month ago
updated 3 days ago
Starred by Chip Huyen Chip Huyen(Author of AI Engineering, Designing Machine Learning Systems), Jeff Hammerbacher Jeff Hammerbacher(Cofounder of Cloudera), and
9 more.

codex by openai

0.9%
32k
Coding agent CLI tool for terminal-based chat-driven development
created 3 months ago
updated 23 hours ago
Feedback? Help us improve.