termy-ai
v0.1.5
Published
🤖 Turn any terminal into an AI-powered assistant
Maintainers
Readme
Termy
⚡ Your AI-powered terminal assistant. Stop googling commands—just ask.
Termy translates your plain English requests into shell commands using Claude AI. Whether you're a beginner learning the command line or an expert who can't remember that obscure flag, Termy has your back.
Demo
https://github.com/user-attachments/assets/e0c8987c-efce-45ea-831d-040b8355b819
Why Termy?
- 💬 Natural Language Interface: Just describe what you want in plain English
- 🤖 Multi-Agent Support: Choose between Claude or Gemini AI
- 🛡️ Safe by Default: Built-in safety checks prevent dangerous operations
- ✋ Always Ask First: Interactive confirmation before executing commands
- 🧠 Smart & Context-Aware: Understands your system and suggests the right commands
- 🎨 Beautiful Output: Clean, colored terminal interface with clear feedback
- ⚡ Lightning Fast: Get the right command in seconds, not minutes of searching
- 🔐 Secure: Reuses your CLI authentication, no extra API keys needed
- 🚀 Developer-Friendly: Works seamlessly with Git, Docker, npm, and all your favorite tools
Quick Start
1. Prerequisites
Termy supports two AI agents: Claude Code and Gemini CLI.
Make sure you have one of them installed and authenticated before using Termy.
2. Install Termy
npm install -g termy-aiThat's it! You're ready to use Termy.
Usage
Simply type ty followed by what you want to do:
ty list all files in this directory
ty find all JavaScript files modified in the last week
ty show me which process is using port 3000
ty compress this folder to a zip fileNote: Quotes are optional in most cases. Only use quotes if your query contains special shell characters like ?, *, [, ], {, }, <, >, |, &, ;, or $.
Real-World Examples
Docker Management:
ty show all running containers
ty stop all containers and remove themFile Operations:
ty find files larger than 100MB
ty count lines of code in all TypeScript filesSystem Monitoring:
ty show disk usage by directory
ty check my CPU and memory usageGit Operations:
ty show git status with branch info
ty list recent commits with author namesConfiguration
To configure Termy (choose AI provider, adjust settings, etc.):
ty configThis opens an interactive configuration menu where you can:
- Switch between Claude and Gemini AI
- Adjust safety settings
- Configure other preferences
Safety First
Termy is designed with safety in mind. It will:
- Always ask for confirmation before executing commands (unless you use
--yes) - Detect dangerous patterns like root directory deletion, disk formatting, fork bombs
- Highlight risks in commands involving
sudo, file deletion, or system changes - Show you exactly what command will run before executing it
You're always in control.
How It Works
- You describe what you want in natural language
- Claude AI generates the appropriate shell command
- Termy shows you the command and asks for confirmation
- You approve (or reject), and Termy executes it
Termy uses the Claude Agent SDK to understand your intent and generate commands that work on your system (macOS, Linux, Windows/WSL).
Development
Want to contribute or run from source?
# Clone the repository
git clone https://github.com/mrphu3074/termy.git
cd termy
# Install dependencies
bun install
# Run in development mode
bun run dev "your command here"
# Run tests
bun testTech Stack
- AI: Claude Agent SDK (Anthropic)
- Runtime: Node.js (v18+)
- Language: TypeScript
- CLI Framework: Commander.js
- Terminal UI: Chalk, Clack
Contributing
We welcome contributions! Feel free to:
- Report bugs or request features via GitHub Issues
- Submit pull requests with improvements
- Share feedback and ideas
License
MIT License - see LICENSE file for details.
Troubleshooting
"no matches found" or "command not found" errors
If you see errors like zsh: no matches found: running?, it means your shell is interpreting special characters in your query.
You have two options to handle special characters:
Option 1: Wrap in double quotes
ty "show me docker containers running?"Option 2: Use interactive mode (recommended)
# Just type 'ty' and press Enter
ty
# Then freely input your query without worrying about special characters
> show me docker containers running?Special characters that need quoting include: ? * [ ] { } < > | & ; $ and others.
Pro tip: Interactive mode (Option 2) is often easier - you never have to worry about escaping or quoting anything!
Support
- Documentation: Full docs
- Issues: GitHub Issues
- Discussions: GitHub Discussions
Built with Claude Agent SDK by Anthropic.
