Skip to content

MartinMinkov/shell-tip

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This Rust program is a command-line tool that leverages the OpenAI GPT-3.5 Turbo model to provide guidance and assistance for Linux shell commands. The AI-powered tool helps users navigate the Linux terminal by suggesting appropriate commands, explaining their usage, and offering best practices.

Features

  • Retrieves assistance and guidance for Linux shell commands from GPT-3.5 Turbo model.
  • Displays response in a formatted and user-friendly way.
  • Configurable parameters such as temperature and number of choices.

Installation

To install the Linux Shell Assistant, follow these steps:

Make sure you have Rust and Cargo installed on your system. If not, follow the instructions at rustup.rs to install Rust.

Clone this repository:

git clone https://github.com/yourusername/shell-tip.git

Change into the cloned repository:

cd shell-tip

Build and install the binary:

./scripts/install.sh

Usage

Run the Linux Shell Assistant by executing the following command:

shell-tip [FLAGS] [OPTIONS] <message>

Parameters

  • message:
    • The message to send to the AI. This should be the question or command you need help with.
  • number_of_choices, -n:
    • The number of choices you'd like the AI to provide (default: 1).
  • temperature, -t:
    • Controls the randomness of the AI's output. Higher values make the output more random, while lower values make it more focused (default: 0.6).

Examples

Get help with a specific command:

shell-tip "How do I list all files in a directory?"

Get multiple suggestions with a higher temperature:

shell-tip -n 3 -t 0.8 "How do I find the size of a directory?"

About

A simple CLI tool that lets me query OpenAI models in the command line

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors