ujjwall-r/cmdbuddy

Your companion for mastering the Linux terminal.

CMDbuddy

Experience terminal mastery made easy with our generative guide, featuring smart command suggestions, typo tolerance, and real-time assistance for seamless navigation and learning.

Preview

Acknowledgements

This project is built upon llm-app. We extend our gratitude to the llm-app contributors for their valuable work and contributions.

Key features

1. Smart Command Suggestions: The guide provides intelligent command suggestions based on user input, making it easier for users to navigate the terminal efficiently.
2. Gives response with respect to your current machine specifications.
3. Typo Tolerance

Get Started

Prerequisites

1. Make sure that Python 3.10 or above installed on your machine.
2. Download and Install Pip to manage project packages.
3. Create an OpenAI account and generate a new API Key: To access the OpenAI API, you will need to create an API Key. You can do this by logging into the OpenAI website and navigating to the API Key management page.

Step 1: Clone the repository

This is done with the git clone command followed by the URL of the repository:

git clone https://github.com/ujjwall-R/CMDbuddy

Next, navigate to the repository:

cd CMDbuddy

Step 2: Set environment variables

Create an .env file in the root directory and add the following environment variables, adjusting their values according to your specific requirements and setup.

For example:

APP_VARIANT=contextful
PATHWAY_REST_CONNECTOR_HOST=0.0.0.0
PATHWAY_REST_CONNECTOR_PORT=8080
OPENAI_API_KEY=<Your Token>
PATHWAY_CACHE_DIR=/tmp/cache

Step 3: Build and deploy custom API [You can test by deploying it locally on port 8080]

You can install and run the LLM App.

• Install poetry:

  pip install poetry

• Install llm_app and dependencies:

  poetry install --with examples --extras local
  pip install poetry

  You can omit --extras local part if you're not going to run local example.

• Run the examples: You can start the example with the command:

  poetry run ./run_examples.py contextful

Step 3: Set CMDbuddy as your tool

Add path to main.sh in ~/.bashrc. If you use zsh add the path in ~/.zshrc.

# Add the following line at the end of the ~/.bashrc file
alias cbuddy='path/to/project/main.sh'

Restart terminal or run:

source ~/.bashrc

Step 4: Start to use it

1.     cbuddy

Troubleshooting

Please check out our Q&A to get solutions for common installation problems and other issues.

Raise an issue

To provide feedback or report a bug, please raise an issue.

Contributing

Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, code cleanup, testing, or code reviews, is very much encouraged to do so.

Coming Soon

• Better query support
• open source llm support

Need help?

Feel free to reach out.