askman-ai

Get what you want from man pages.

LLMs often hallucinate on niche Linux questions, have them refer to your system’s man pages for more accurate answers.

Setup

1. Prerequisites:

• Google API Key: Obtain an API key from the Google AI Studio here.

2. Installation

1. Clone the repository:

   git clone https://github.com/udqy/askman-ai
   cd askman-ai

2. Create a virtual environment (recommended):

   python -m venv venv
   source venv/bin/activate 

3. Install dependencies:

   pip install -r requirements.txt

4. Set up environment variables: Copy the .env.example to .env and add your Google API key:

   cp .env.example .env

Usage

1. Create the Vector Database

Before you can ask questions, you need to create a vector store from your man pages. Run the following command:

python src/main.py --create-db --docs-path data/man-txt --db-path data/faiss_index

2. Ask Questions

Once the database is created, you can start asking questions:

python main.py  "How do I use the grep command to find patterns?"