claix: Command Line AI eXpert
Transforming user instructions into CLI commands with the power of GPT-4, right in your terminal.
Key Features
- AI-Powered Command Generation: Uses GPT-4 for interpreting and translating natural language instructions into CLI commands.
- Integrated Terminal Workflow: Directly operates in the terminal for enhanced efficiency.
- Automated Error Handling: Processes command execution errors and suggests alternative commands.
- User Convenience: Eliminates the need for copy-pasting from web browsers.
- Adaptive Solutions: Generates alternative commands based on the context of encountered errors.
Prerequisites
- Python 3.10+
OPENAI_API_KEYenvironment variable set up
Installation
pip install --upgrade claix
Usage Examples
| Task | Instruction | Output |
|---|---|---|
| Change file extensions | claix change the extension of all files under images/ from .jpeg to .jpg |
find images/ -type f -name "*.jpeg" -exec sh -c 'x="{}"; mv "$x" "${x%.jpeg}.jpg"' \; |
| List Git branches | claix list all git branches in order of creation |
git for-each-ref --sort=creatordate --format '%(refname:short)' refs/heads/ |
| Find large files | claix find all files larger than 10MB in this directory |
find . -type f -size +10M |
Contributing
We welcome contributions to claix! Here's how you can contribute:
- Fork the project.
- Create a feature branch.
- Commit your changes.
- Push to the branch.
- Open a pull request.
License
claix is released under the MIT License.
Contact
For queries or contributions, contact via email at facundogoiriz@gmail.com or on GitHub at fakamoto.
Future Plans
- Enhanced UI.
- Function calling capabilities.
- Integration of external commands.
- Adaptation of commands based on environmental data.
FAQs
Q: How accurate are the commands generated by claix?
A: claix uses a gpt-4o-mini powered assistant specialized in CLIs for high accuracy.
Q: Can it handle complex instructions?
A: Currently optimized for single-step commands, with plans to handle multi-step instructions in the future.
Q: What if claix doesn't understand my instruction?
A: Try rephrasing or simplifying. claix is continually improving in understanding various instructions.
Q: What are the limitations of claix's commands?
A: Best suited for Linux CLI commands; may not handle highly specialized or context-specific commands well.
Q: How does claix handle errors from executed commands?
A: It suggests alternative commands by analyzing the error context, reducing the need for manual intervention.
1 maintainer
Metadata
1 maintainer
Release files for claix 0.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| claix-0.1.7.tar.gz | 7.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| claix-0.1.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 17.0 kB
Release files / claix-0.1.7.tar.gz
| Download URL | claix-0.1.7.tar.gz |
|---|---|
| Size | 7.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
39dcec4f6a5ccc516d9cf211d31a3dc57eb323b9b871117f7a6068dd2f252cd2
|
|
BLAKE2b-256 checksum How to use checksums |
cde848392bb8cdac9f4172d7dfdcf9ae67b98ec9bda32c0810a9701021450a77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.11.0 Linux/6.17.0-1018-azure
|
Release files / claix-0.1.7-py3-none-any.whl
| Download URL | claix-0.1.7-py3-none-any.whl |
|---|---|
| Size | 9.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a86c5799941623c81e205eefe44121a690fb7850aef7b5910e28024a3f9ee760
|
|
BLAKE2b-256 checksum How to use checksums |
f732f1bb6f963c9ad72db194253e299ae331e0ba50bb9d6cc96c0089576b684c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.11.0 Linux/6.17.0-1018-azure
|
