Your AI-powered CLI companion

Enhance your terminal workflow with natural language processing

Get Started View on GitHub

About Shuru

Shuru is your local AI assistant for the command line. Ask questions in plain English, and get instant help with terminal commands and project tasks.

Works offline with Ollama, or connect to AI providers like OpenAI and Gemini. You choose how you want to run it.

$ shuru --ai
👋 Hey there! I am Shuru AI!
I'm here to help you set up and manage your project. Let's get started! What would you like to do?

✔ → · setup a new nodejs project
✓ Got it! Here's what I suggest:

📋 Planned Actions:
──────────────────────────────────────────────────

Type: ProjectSetup
Description: Set up a new Node.js project

1. 📁 Create directory: nodejs-project
2. 📁 Change Work Directory: nodejs-project
3. ▶️ Run: npm init -y

──────────────────────────────────────────────────
? What would you like to do? ›
❯ Execute plan
  Modify plan
  Start over
  Exit

Features

🔒 Your Choice of AI

Run completely offline with Ollama, or connect to cloud providers like OpenAI and Gemini. You're in control of your data.

🚀 Cross-Platform

Works seamlessly on Linux, macOS, and Windows terminals.

🤖 AI-Powered

Leverages advanced language models to understand and assist with complex commands.

⚡ Lightning Fast

Optimized for speed with local execution and minimal latency.

Installation

Quick Install

sh -c "$(curl -fsSL https://shuru.run/install.sh)"

From Source

git clone https://github.com/shuru-project/shuru
cd shuru
cargo build --release

Configuration

Create ~/.shuru/config.toml with your AI provider settings:

[ai]
default_provider = "openai"

[ai.providers.openai]
api_key = "YOUR_OPENAI_API_KEY"
model = "gpt-4-turbo"

[ai.providers.gemini]
api_key = "YOUR_GEMINI_API_KEY"
model = "gemini-1.5-pro"