Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pgibler/cmdh
Create Linux commands from natural language, in the shell.
https://github.com/pgibler/cmdh
artificial-intelligence automation shell typescript
Last synced: about 2 months ago
JSON representation
Create Linux commands from natural language, in the shell.
- Host: GitHub
- URL: https://github.com/pgibler/cmdh
- Owner: pgibler
- License: mit
- Created: 2023-04-18T22:43:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-06T02:59:07.000Z (7 months ago)
- Last Synced: 2024-05-05T17:32:54.815Z (5 months ago)
- Topics: artificial-intelligence, automation, shell, typescript
- Language: TypeScript
- Homepage:
- Size: 130 KB
- Stars: 72
- Watchers: 3
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cmdh - Generate Linux commands using an LLM
cmdh (short for Command Helper) is a tool that invokes LLM models provided by ollama or OpenAI to convert a command request into a desired command.
Use it to look up commands and flags that that you don't know offhand or generate complex commands with chaining.
[cmdh_demonstration_video.webm](https://user-images.githubusercontent.com/119892/233747166-552339ef-f3fe-4eb5-9161-db574b6f96fc.webm)
## Features
- Generate Linux commands from natural language
- Interactively run the commands using a hotkey menu system
- Differentiates between shell command types: interactive and non-interactive
- Supports [ChatGPT](https://platform.openai.com/docs/overview), [ollama](https://ollama.ai/), and [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
## Prerequisites
- NodeJS - [installation guide](https://nodejs.org/en/download/package-manager)
- npm - [installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- tsc - [installation guide](https://www.npmjs.com/package/typescript)
## Installation
1. Set up and configure cmdh using the following command:
```
git clone https://github.com/pgibler/cmdh.git && cd cmdh && ./install.sh
```
2. Run it like so:
```
cmdh 'Output the number of lines of code committed to git last month'
```
3. Interact with the result interface to run the setup commands, desired command, all of the commands, or quit.
**NOTE**: You will have to reload your .bashrc / .zshrc / etc. or open a new terminal to make the cmdh command available in the shell. In Debian / Ubuntu, this is done by running `source ~/.bashrc`.
## Configuring
Before running cmdh, you will need to configure an LLM host and set configuration options required of that host.
- Run `cmdh configure` to start the configuration wizard. You will be asked to select an LLM host and input settings required by that host.
- Run `cmdh configure show` to display your current configuration.
### OpenAI
1. Generate an OpenAI key [here](https://platform.openai.com/api-keys).
2. Run `cmdh configure` and select the OpenAI option.
3. Select a model & input your OpenAI key.
### ollama
1. Install & run the ollama service & pull the codellama model using the following commands:
```
curl https://ollama.ai/install.sh | sh
ollama pull codellama
```
2. Run `cmdh configure`, select the ollama option, and set 'codellama' as the model.
### text-generation-webui
1. Clone the repo: `git clone https://github.com/oobabooga/text-generation-webui`
2. Navigate to the cloned text-generation-webui folder and start the server by running `./start_linux --api --listen`.
3. Open the web UI for text-generation-webui (http://localhost:7860), open the "Model" tab, and in the "Download model or LoRA" form, input `Trelis/Llama-2-7b-chat-hf-function-calling-v2` and press "Download".
4. Click the reload button next to the Model dropdown menu under the model tab & select `llama-2-7b-function-calling.Q3_K_M.gguf`. Then click "Load" to load the model.
2. Run `cmdh configure` and choose the 'text-generation-webui' option.
cmdh will automatically send the prompts to whichever model is loaded by text-generation-webui.
HuggingFace model URL: [https://huggingface.co/Trelis/Llama-2-7b-chat-hf-function-calling-v2](https://huggingface.co/Trelis/Llama-2-7b-chat-hf-function-calling-v2)
## Roadmap
The issue tracker is mostly feature requests I have put in so I don't forget them. If you have any bug reports or good ideas, please include them in the tracker.
## Issues
If you run into any issues installing or running cmdh, please open a ticket in the project tracker. Include a detailed bug report with stacktraces and inputs and the mode of operation (OpenAI or ollama).