Documentation
Welcome to the hi-shell documentation. hi-shell is an intelligent terminal assistant that translates natural language descriptions into executable shell commands.
Quick Links
Getting Started
Install hi-shell and run your first AI-generated command.
Embedded Models
Run LLM models locally with hardware acceleration.
Configuration
Customize hi-shell behavior with config files.
How It Works
- You describe what you want to do in natural language
- hi-shell sends your description to an LLM (local or cloud)
- The LLM generates the appropriate shell command
- hi-shell shows the command and asks for confirmation
- You review and approve before execution
Provider Options
| Provider | Type | Requires Internet | Setup Difficulty |
|---|---|---|---|
| Embedded Models | Local | No (download only) | Easy |
| Ollama | Local | No | Easy |
| LM Studio | Local | No | Easy |
| OpenRouter | Cloud | Yes | Easy |
| Anthropic | Cloud | Yes | Easy |
| OpenAI | Cloud | Yes | Easy |
Need Help?
- Check the Troubleshooting guide for common issues
- Browse the FAQ for frequently asked questions
- Open an issue on GitHub