askk v1.0.2

Askk - CLI Assistant

Askk is a command-line assistant that helps generate commands based on user prompts. It provides four options for executing or handling the generated command: Run, Copy, Follow Up, and Exit.

Features

• Accepts user prompts and returns relevant shell commands.
• Provides four options:
  • Run: Executes the command directly in the terminal.
  • Copy: Copies the command to the clipboard.
  • Follow Up: Allows users to refine their query.
  • Exit: Exits the assistant.
• Requires an API key setup before use.

Installation

npm install -g askk

Setup

Before using Askk, you must set up your OPENAI API key.

askk --setKey=<your_api_key_here>

Usage

Simply run the command and enter a prompt:

askk How do I list all running Docker containers

You will receive a command along with four options:

docker ps
1. Run  2. Copy  3. Follow Up  4. Exit

Choose an option by entering the corresponding number.

Example

askk Create a new Next.js app with TypeScript

Output:

npx create-next-app@latest my-app --typescript
1. Run  2. Copy  3. Follow Up  4. Exit

Configuration

To update the API key:

askk --setKey=<your_api_key_here>

To remove the API key:

askk --rmKey

Contributing

Feel free to open an issue or submit a pull request if you have suggestions or improvements.

License

MIT