quectoclaw 0.1.0

QuectoClaw β€” Ultra-efficient AI assistant in Rust
Documentation

πŸš€ Overview

QuectoClaw is a high-performance, self-contained AI agentic coding assistant designed for speed and flexibility. Unlike heavy Python/Node.js alternatives, QuectoClaw compiles to a single <5MB binary with zero runtime dependencies.

It connects to any OpenAI-compatible LLM (OpenAI, Anthropic, Ollama, Groq) and orchestrates a powerful loop of tools, sub-agents, and plugins to solve complex tasksβ€”from coding and debugging to research and system automation.

Why QuectoClaw?

  • ⚑ Blazing Fast: Rust-based architecture with async I/O and minimal memory footprint.
  • πŸ”Œ Universal Connectivity: First-class support for Model Context Protocol (MCP) and OpenAI API standards.
  • πŸ›‘οΈ Secure & Auditable: Built-in tamper-proof Audit Logging and sandboxed execution.
  • 🧩 Extensible: Drop-in WASM and JSON plugins, plus a YAML-based workflow engine.
  • πŸ–₯️ Multi-Interface: Interactive CLI, TUI Dashboard, Web UI, and Telegram/Discord Gateway.

πŸ“¦ Installation

From Source

Ensure you have Rust installed (cargo).

# Clone the repository
git clone https://github.com/your-username/QuectoClaw.git
cd QuectoClaw

# Build optimized release binary
cargo build --release

The binary will be available at target/release/quectoclaw.

Feature Flags

Enable additional capabilities during build:

# Enable WASM Plugin Runtime
cargo build --release --features wasm

# Enable Telegram & Discord Gateway
cargo build --release --features "telegram,discord"

# Enable All Features
cargo build --release --all-features

⚑ Quick Start

1. Initialize

Run the onboarding wizard to set up your configuration and workspace:

quectoclaw onboard

Creates ~/.quectoclaw/config.json and workspace templates.

2. Configure

Edit ~/.quectoclaw/config.json to add your LLM API key:

"providers": {
  "openai": {
    "api_key": "sk-your-key-here",
    "api_base": "https://api.openai.com/v1"
  }
}

3. Run

Interactive Agent Mode:

quectoclaw

One-Shot Command:

quectoclaw agent -m "Analyze the src/ dir and explain the architecture"

Workflow Automation:

quectoclaw run ./workflows/audit-codebase.yaml

✨ Features

πŸ› οΈ Powerful Tool Suite

QuectoClaw comes with a robust set of built-in tools:

Category Tools Description
System exec, list_dir Safe shell execution and recursive directory listing.
Filesystem read_file, write_file, edit_file, append_file Full file manipulation with surgical editing capabilities.
Web web_search, web_fetch Live internet access via search APIs and content fetching.
Memory vectordb_index, vectordb_search RAG-powered long-term memory for semantic context.
Meta subagent Spawns hierarchical sub-agents for complex task delegation.

πŸ”Œ MCP Support (Model Context Protocol)

Connect standard MCP servers to extend QuectoClaw's capabilities instantly.

Config example:

"mcp": {
  "servers": {
    "sqlite": {
      "command": "uvx",
      "args": ["mcp-server-sqlite", "--db-path", "test.db"]
    }
  }
}

🧩 WASM & JSON Plugins

Extend the agent without recompiling.

  • WASM Plugins: Python/JS/Rust code compiled to WASM for sandboxed execution (workspace/wasm_plugins).
  • JSON Plugins: Simple command wrappers (workspace/plugins).

πŸ“Š TUI Dashboard & Web UI

Monitor your agent in real-time.

Terminal Dashboard:

quectoclaw dashboard

Web Interface:

quectoclaw webui --port 3000

πŸ“œ Robust Audit Logging

Enterprise-grade audit trails for every action.

# View recent logs
quectoclaw audit --limit 50

# Follow live logs
quectoclaw audit --follow

πŸ—οΈ Architecture

QuectoClaw is built on a modular, event-driven architecture:

graph TD
    CLI[CLI / TUI] --> Loop[Agent Loop]
    Loop --> Provider[LLM Provider]
    Loop --> Tools[Tool Registry]
    Loop --> Memory[Vector Memory]
    
    Tools --> Builtin[Built-in Tools]
    Tools --> MCP[MCP Client]
    Tools --> WASM[WASM Runtime]
    
    MCP --> ext[External MCP Servers]
    
    Loop --> Audit[Audit Logger]
    Loop --> Gateway[Multi-Channel Gateway]
    
    Gateway --> Telegram
    Gateway --> Discord

See plan.md for a detailed deep-dive.


πŸ—ΊοΈ Roadmap

Phase Feature Status
1-6 Core Agent, Streaming, TUI, Split-Brain βœ… Complete
7 MCP Support, Vector DB, Web UI βœ… Complete
8 Audit Logging, Workflow Engine βœ… Complete
9 WASM Runtime, Plugin Marketplace βœ… Complete
10 Cross-platform Binaries, Docker, Homebrew 🚧 In Progress

🀝 Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repo.
  2. Create a feature branch (git checkout -b feature/amazing-feature).
  3. Commit your changes (Standard Conventional Commits).
  4. Push to the branch.
  5. Open a Pull Request.

Development Commands:

cargo test          # Run all tests
cargo clippy        # Lint code
cargo fmt           # Format code

πŸ“„ License

Distributed under the Apache 2.0 License. See LICENSE for more information.