README
¶
AI-Terminal
🇺🇸 English | 🇨🇳 中文 | 🇯🇵 日本語
AI-Terminal is an AI-powered command-line interface that enhances terminal workflows through intelligent automation and optimization.
Features
- Smart Assistance: Context-aware command suggestions and completions
- Task Automation: Automate repetitive tasks with AI-generated shortcuts
- Intelligent Search: Advanced file and content search capabilities
- Error Handling: Command correction and alternative suggestions
- Extensible: Plugin system for custom integrations
Quick Start
Prerequisites
- Go 1.22.0 or later
Installation
Homebrew:
brew install coding-hui/tap/ai-terminal
Download:
From Source:
make build
Initialize:
ai configure
Shell Completions
Completion files are included for Bash, ZSH, Fish, and PowerShell. Generate manually with:
ai completion [bash|zsh|fish|powershell] -h
Usage Examples
Chat & Assistance
ai ask "How to optimize Docker performance?"
ai ask --file prompt.txt
echo "code content" | ai ask "analyze this code"
Code Generation
# Interactive mode
ai coder
# Batch processing
ai ctx load context.txt
ai coder -c session_id -p "add error handling"
Code Review
ai review --exclude-list "*.md,*.txt"
Command Execution
ai exec "find large files from last week"
ai exec --yes "docker ps -a"
ai exec --interactive
Commit Messages
ai commit --diff-unified 3 --lang en
Contributing
See CONTRIBUTING.md for guidelines.
Changelog: CHANGELOG.md
License: MIT © 2024 coding-hui
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
cli
command
|
|
|
internal
|
|
|
cli
Package cli create a root cobra command and add subcommands to it.
|
Package cli create a root cobra command and add subcommands to it. |
|
cli/completion
Package completion output shell completion code for the specified shell (bash or zsh).
|
Package completion output shell completion code for the specified shell (bash or zsh). |
|
cli/version
Package version print the client and server version information.
|
Package version print the client and server version information. |
|
options
Package options print a list of global command-line options (applies to all commands).
|
Package options print a list of global command-line options (applies to all commands). |
|
ui/chat
Package chat implements the terminal-based chat interface for AI interactions.
|
Package chat implements the terminal-based chat interface for AI interactions. |
|
ui/coders
Package coders provides interfaces and types for working with code editors.
|
Package coders provides interfaces and types for working with code editors. |
|
util/templates
Package templates provides template functions for working with templates.
|
Package templates provides template functions for working with templates. |
|
util/term
Package term provides structures and helper functions to work with terminal (state, sizes).
|
Package term provides structures and helper functions to work with terminal (state, sizes). |
Click to show internal directories.
Click to hide internal directories.