README
¶
AI-Terminal
AI-Terminal is an advanced AI-powered CLI that enhances terminal workflows through AI-driven automation and optimization. It efficiently manages tasks such as file management, data processing, and system diagnostics.
Key Features
- Contextual Assistance: Learns from user commands to provide syntax suggestions.
- Automated Tasks: Recognizes repetitive task patterns and creates shortcuts.
- Intelligent Search: Conducts searches within files, directories, and specific file types.
- Error Correction: Corrects incorrect commands and suggests alternatives.
- Custom Integrations: Supports integration with various tools and services via plugins or APIs.
Getting Started
Prerequisites
- Go version v1.22.0 or higher.
Installation
Build and install the Go binary:
make build
Usage
Usage Examples:
-
Initiate a Chat:
ai ask "What is the best way to manage Docker containers?" -
Generate a Commit Message:
ai commit --diff-unified 3 --lang en -
Auto-generate Code:
ai coder -
Review Code Changes:
ai review --exclude-list "*.md,*.txt"
Contributing
Contribution guidelines will be provided soon. For more information, run make help.
License
Copyright 2024 coding-hui. Licensed under the MIT License.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
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/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). |
|
cli/version
Package version print the client and server version information.
|
Package version print the client and server version information. |
|
coders
Package coders provides interfaces and types for working with code editors.
|
Package coders provides interfaces and types for working with code editors. |
|
util/interrupt
Package interrupt deal with signals.
|
Package interrupt deal with signals. |
|
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.