Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.57 KB

README.md

File metadata and controls

36 lines (25 loc) · 1.57 KB
Raw

Snorlax

Short Description of Unix/Linux commands by one other command.

Getting Started

Snorlax is written in Python which gives you a short description of a Unix/Linux command that you are going to type. I work with bash all the time and use bash for every command I type and every program I make so searching on web for a command all the time is a tedious job. Man pages are also very lengthy and sometimes when you are so much indulged in your work you don't want to diverge your mind to some other topic (reading man page of command).

Prerequisites

I was using Ubuntu 16.04 during the time I coded snorlax. Snorlax will work on MacOS or any Linux distro. You should have Python 2.7 plus some additional packages installed on your system.

Installing

Python 2.7 is already installed on most of the Linux distro.

  1. Install pip by command - sudo apt-get install python-pip
  2. Use command - pip install -r requirements.txt to install additional packages.
  3. For GPT API_KEY create .env and paste over there API_KEY = "Your openai API_KEY"

To-Do List

  1. Render the HTML on CLI using pandoc.
  2. Get some source website to search for commands.

EXAMPLE

Video and screenshot will be added soon.

Built With

Contributing

Feel free to fork it and I welcome your contribution to make snorlax bigger and better.

Version

Snorlax Version = 1.0

License

This project is licensed under the MIT license - see the LICENSE file for details.