Vertex CLI

Vertex CLI is a powerful command-line tool that leverages Large Language Models (LLMs) to answer queries and debug faster. With just a few commands, you can set up and start using advanced features like querying LLMs and generating insights.

Complete Documentation: Vertex CLI Docs

---

Installation and Setup

Follow these steps to get started:

Install Vertex-CLI from TestPyPI

To install Vertex-CLI from TestPyPI, run:

pip install --index-url https://test.pypi.org/simple/ Vertex-CLI==0.1.39

After installation, initialize the CLI:

tex-init

---

Install the Editable Version (For Development)

If you want to modify or contribute to Vertex CLI, install it in editable mode:

1. Clone the repository:

   git clone https://github.com/Prtm2110/Vertex-CLI
   cd Vertex-CLI

2. Install dependencies and set up the project:

   pip install -e .

3. Initialize the CLI:

   tex-init

---

Configuration

You can configure the CLI to use a specific LLM model:

tex --config gemini-1.5-flash <model-api-key>

Replace gemini-1.5-flash with your preferred model name and <model-api-key> with your API key.

---

Usage

Once installed, you can start using Vertex CLI by running:

tex "tell me about the solar system"

Replace "tell me about solar system" with any query you'd like.

🔗 Complete CLI Documentation: CLI Commands

---

Debugging Mode (Beta Feature)

Debugging is currently in beta but can analyze recent commands to identify issues.

Debug the Last Two Commands

tex --debug

Specify the Number of Commands to Debug

To debug the last 5 commands:

tex --debug --5

Add a Custom Debugging Message

Provide additional context while debugging:

tex "I believe this can be solved by changing the environment variable" --debug

---

Contributing

Contributions are welcome! Follow these steps to contribute:

1. Fork the repository
2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Commit your changes:

   git commit -m "Add your feature description"

4. Push your branch:

   git push origin feature/your-feature-name

5. Open a pull request

🔗 Contributor Guide: How to Contribute

---

License

This project is licensed under the MIT License. See the LICENSE file for more details.

---

Support

If you encounter any issues, open an issue on the GitHub repository.