claix

Name	claix JSON
Version	0.1.6 JSON
	download
home_page	None
Summary	A CLI translating user requests into specific CLI commands
upload_time	2024-10-16 05:10:03
maintainer	None
docs_url	None
author	Facundo Goiriz
requires_python	<4.0,>=3.10
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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_KEY` environment variable set up

  
## Installation

```bash
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](https://github.com/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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "claix",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Facundo Goiriz",
    "author_email": "facundogoiriz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/28/18/fb1a138a7ebecc72c2cb5d359837748b9377c88a8e10cce9399fe4aa3290/claix-0.1.6.tar.gz",
    "platform": null,
    "description": "# claix: Command Line AI eXpert\n\n**Transforming user instructions into CLI commands with the power of GPT-4, right in your terminal.**\n\n## Key Features\n\n- **AI-Powered Command Generation**: Uses GPT-4 for interpreting and translating natural language instructions into CLI commands.\n- **Integrated Terminal Workflow**: Directly operates in the terminal for enhanced efficiency.\n- **Automated Error Handling**: Processes command execution errors and suggests alternative commands.\n- **User Convenience**: Eliminates the need for copy-pasting from web browsers.\n- **Adaptive Solutions**: Generates alternative commands based on the context of encountered errors.\n\n## Prerequisites\n\n- Python 3.10+\n- `OPENAI_API_KEY` environment variable set up\n\n  \n## Installation\n\n```bash\npip install --upgrade claix\n```\n\n\n\n\n## Usage Examples\n\n| Task | Instruction | Output |\n|------|-------------|--------|\n| **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\"' \\;` |\n| **List Git branches** | `claix list all git branches in order of creation` | `git for-each-ref --sort=creatordate --format '%(refname:short)' refs/heads/` |\n| **Find large files** | `claix find all files larger than 10MB in this directory` | `find . -type f -size +10M` |\n\n## Contributing\n\nWe welcome contributions to claix! Here's how you can contribute:\n- Fork the project.\n- Create a feature branch.\n- Commit your changes.\n- Push to the branch.\n- Open a pull request.\n\n## License\n\nclaix is released under the MIT License.\n\n## Contact\n\nFor queries or contributions, contact via email at facundogoiriz@gmail.com or on GitHub at [fakamoto](https://github.com/fakamoto).\n\n## Future Plans\n\n- Enhanced UI.\n- Function calling capabilities.\n- Integration of external commands.\n- Adaptation of commands based on environmental data.\n\n## FAQs\n\n**Q: How accurate are the commands generated by claix?**  \nA: claix uses a gpt-4o-mini powered assistant specialized in CLIs for high accuracy.\n\n**Q: Can it handle complex instructions?**  \nA: Currently optimized for single-step commands, with plans to handle multi-step instructions in the future.\n\n**Q: What if claix doesn't understand my instruction?**  \nA: Try rephrasing or simplifying. claix is continually improving in understanding various instructions.\n\n**Q: What are the limitations of claix's commands?**  \nA: Best suited for Linux CLI commands; may not handle highly specialized or context-specific commands well.\n\n**Q: How does claix handle errors from executed commands?**  \nA: It suggests alternative commands by analyzing the error context, reducing the need for manual intervention.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A CLI translating user requests into specific CLI commands",
    "version": "0.1.6",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a2823ad0926d8c28df1083c322a42504a2b10660be9632fd7e96a267e8028e0c",
                "md5": "2841fcfcb0ae1496c9a53b04e102b087",
                "sha256": "e255ff903b06bf9442ad73c4fc9c1f653f643da55bc220d1b45d27fc9ed63812"
            },
            "downloads": -1,
            "filename": "claix-0.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2841fcfcb0ae1496c9a53b04e102b087",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 8418,
            "upload_time": "2024-10-16T05:10:02",
            "upload_time_iso_8601": "2024-10-16T05:10:02.571607Z",
            "url": "https://files.pythonhosted.org/packages/a2/82/3ad0926d8c28df1083c322a42504a2b10660be9632fd7e96a267e8028e0c/claix-0.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2818fb1a138a7ebecc72c2cb5d359837748b9377c88a8e10cce9399fe4aa3290",
                "md5": "9ec5786a1bd5a65d3810097e20c73951",
                "sha256": "9006ffda5f3d1f153c9c5db762f453070c6a5bc5977101077ce88b07f7b687b0"
            },
            "downloads": -1,
            "filename": "claix-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "9ec5786a1bd5a65d3810097e20c73951",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 7821,
            "upload_time": "2024-10-16T05:10:03",
            "upload_time_iso_8601": "2024-10-16T05:10:03.813038Z",
            "url": "https://files.pythonhosted.org/packages/28/18/fb1a138a7ebecc72c2cb5d359837748b9377c88a8e10cce9399fe4aa3290/claix-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-16 05:10:03",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "claix"
}