Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akash-joshi/howitzer
Generate, explain and execute commands in the CLI
https://github.com/akash-joshi/howitzer
Last synced: 12 days ago
JSON representation
Generate, explain and execute commands in the CLI
- Host: GitHub
- URL: https://github.com/akash-joshi/howitzer
- Owner: akash-joshi
- Created: 2023-11-03T19:15:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-06T06:48:02.000Z (3 months ago)
- Last Synced: 2024-08-18T08:06:09.804Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 6.19 MB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Howitzer CLI Helper
### Description
⚡️ An AI CLI which Generates, Explains and Executes commands inline.
No more faffing about with Stackoverflow or other websites, iterate on and understand commands in your CLI directly!
https://github.com/akash-joshi/how-cli-copilot/assets/22196279/947da09c-a1fe-4e4f-a1ff-6c0752a8c0e6
### Installation
1. Run `npm i -g hey-how` to install the tool globally.
2. Run `how ` to run any queries in your CLI.
### Usage
```bash
how [options] [query]
```
### Arguments
- `[query]`: Enter your query in plain text. This will be used to generate a CLI command.
### Examples
```bash
how do i convert random.pdf to jpeg
```
### Options
- `-c, --config`: Configure API key.
- `-d, --debug`: Log debug data.
### Usage
The tool acts as an AI assistant that responds with Unix command line instructions based on the provided query. It returns the most relevant Unix command to accomplish what the user is asking. The response is provided in JSON format and includes the command along with a brief explanation.
### Execution
- Upon receiving the command, the tool executes it with a prompt asking if the user wants to run the command.
- If the user agrees, the command is executed, and the output is displayed.
- If the user disagrees, the execution stops.
### Dependencies
- commander
- inquirer
- conf