Skip to content

akash-joshi/how-cli-copilot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

How CLI Tool

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!

How.mp4

Installation

  1. Run npm i -g hey-how to install the tool globally.
  2. Run how <your_query> to run any queries in your CLI.

Usage

how [options] [query]

Arguments

  • [query]: Enter your query in plain text. This will be used to generate a CLI command.

Examples

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

About

Generate, explain and execute commands in the CLI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published