---

📺 Demo

Experience an interactive AI pair programming session directly in your terminal:

---

⚙️ Installation

To install windmist (v2.0.1) using the Go toolchain (Go 1.26+ required):

go install github.com/Nithwin/WindMist@latest

Or clone and build directly from source:

git clone https://github.com/Nithwin/WindMist.git
cd WindMist
go build -o windmist .

Or use the universal installer (Linux/macOS):

curl -sSL https://raw.githubusercontent.com/Nithwin/WindMist/v2/scripts/install.sh | bash

---

🚀 Quick Start

1. Set your Gemini API Key (or export it in your environment):

   export GEMINI_API_KEY="your-gemini-api-key"
   

2. Launch the interactive Terminal UI:

   ./windmist
   

3. Or run a single-turn prompt directly against your repository:

   ./windmist chat "Examine internal/agent and summarize the tool loop"
   

---

✨ Features & Capabilities

WindMist (v2.0.1) provides a robust, native engineering environment inside your terminal:

• ✅ Interactive AI Chat & TUI: Rich Bubble Tea and Lip Gloss interface with real-time streaming, markdown rendering, and syntax coloring.
• ✅ Multi-Agent Orchestration: Delegate background research to cheaper, faster Sub-agents while keeping your main context clean.
• ✅ RAG & Context Memory: A lightweight, pure-Go TF-IDF vector database that semantically indexes your workspace so the agent never hallucinates.
• ✅ Extensibility via MCP: Full support for the Model Context Protocol, enabling dynamic external tools (e.g., GitHub Auth, database connectors).
• ✅ Remote Control Hub: Connect a Telegram Bot (/remote) to actively monitor, steer, and prompt your WindMist agent remotely.
• ✅ 15 Atomic Filesystem & Editing Tools (internal/tools/...):
  • Filesystem Operations: read, write, append, delete, rename, list, create, info, exists.
  • Precision Editing: replace_text, replace_range, delete_range, read_context, insert_text, search_text.
• ✅ Autonomous Agent Loop (internal/agent): Stateless multi-turn reasoning loop with automated tool execution, context tracking, and self-correction.

---

🛠️ Core Commands

Command	Description
windmist	Launch the rich interactive Bubble Tea Terminal UI session.
windmist chat <prompt>	Run a single-turn or multi-turn agent instruction directly from the command line.
windmist set <key> <val>	Configure local environment and provider settings (~/.windmist/config.yaml).
windmist show	Display current local configuration settings.
windmist version	Print current semantic release build version (v2.0.1).

---

💡 Why WindMist?

Our mission is to provide an open-source AI coding assistant that operates with native execution speed, deep workspace awareness, and complete local sovereignty over your development workflows.

Most AI CLI tools struggle with sluggish startup times or cumbersome configuration requirements. WindMist eliminates this overhead by isolating everything close to your terminal—CLI parsing, interactive Bubble Tea UX, concurrent file walking, and the autonomous tool execution loop—strictly inside a high-performance Go core (internal/).

---

📐 Architecture Overview

For a comprehensive breakdown of our system architecture, domain-driven Go modules (internal/), and multi-turn execution loop, please read docs/architecture.md.

---

🤝 Contributing

Whether you are fixing bugs, improving documentation, or designing new tools, we treat this project with the engineering rigor of a top-tier open-source product:

• Users & Newcomers: Check out our Quick Start to begin pairing with WindMist.
• Contributors: Please review CONTRIBUTING.md for local setup, branch conventions (feat/, fix/), and our testing rules (go test ./...).
• Security: Review SECURITY.md for our threat models (Workspace boundaries, Tool permissions, Unsafe commands).

---

📄 License

This project is licensed under the MIT License — see the LICENSE file for details.

---