Skip to content

README.md

Latest commit

 

History

History
117 lines (82 loc) · 3.63 KB

README.md

File metadata and controls

117 lines (82 loc) · 3.63 KB

🐦 Lumo

Your AI-Powered Terminal Assistant

getlumo.dev

Version 1.0.1 Go Version License MIT

📖 Overview

Lumo is an intelligent CLI assistant that interprets natural language to help you navigate the terminal with ease. It bridges the gap between natural language and terminal commands using advanced AI models.

For comprehensive documentation, visit getlumo.dev

🌟 Key Features

  • Natural Language Command Processing: Translate plain English into terminal commands
  • Agent Mode: Autonomous planning and execution of command sequences
  • Chat Mode: Conversational assistance for terminal and general queries
  • Desktop Assistant: Control your desktop environment with natural language
  • System Monitoring: Track system health and performance
  • Pipe Support: Analyze and explain command outputs
  • Web Interface: Access Lumo through a browser-based interface
  • Secure Authentication: JWT-based authentication for the REST API
  • Multiple AI Providers: Support for Google Gemini, OpenAI, and Ollama

🚀 Installation

Quick Install

# Using pre-built binary (Linux)
curl -L https://github.com/agnath18K/lumo_cli/releases/download/v1.0.2/lumo_1.0.2_linux_amd64.tar.gz -o lumo.tar.gz
tar -xzf lumo.tar.gz
sudo mv lumo /usr/local/bin/

# Using Debian package
curl -L https://github.com/agnath18K/lumo_cli/releases/download/v1.0.2/lumo_1.0.2_amd64.deb -o lumo.deb
sudo dpkg -i lumo.deb

For detailed installation instructions and system requirements, visit getlumo.dev/installation

🔍 Usage

# Basic usage - ask in natural language
lumo "How do I find large files in Linux?"

# Agent mode - execute sequences of commands
lumo auto:create a backup of my documents folder

# Chat mode - conversational assistance
lumo chat

# Pipe support - analyze command output
ls -la | lumo

# System health check
lumo health

# Internet speed test
lumo speed

# Desktop assistant
lumo desktop:"close firefox window"
lumo desktop:"launch terminal"

# Web interface - start the server and access via browser
lumo server:start
# Then open http://localhost:7531 in your browser
# Default credentials: admin / lumo

# Enable authentication for the REST API
lumo config:server auth enable

For complete usage documentation and examples, visit getlumo.dev/documentation

For information about the authentication system, see Authentication Documentation

🛠️ Development

For development documentation, visit getlumo.dev/documentation

Contributions to Lumo are welcome! Please fork the repository and submit a pull request.

📜 License

Lumo is released under the MIT License.

Website • GitHub • Issues

Designed by agnath18