Ask Jef!

Your terminal assistant 😉

---

Table of Contents

Table of Contents

1. Installation
   1.1 Prerequisites
   1.2 Building
2. Usage
   2.1 Flags

---

Installation

Prerequisites

Before you start make sure you have set up the following:

• LocalAI
• Go

Building

1. Clone this repository:

git clone https://github.com/rumenmitov/ask-jef.git

2. Run the installation script:

cd ask-jef
make install

Usage

There two ways of running the program. Either:

ask "your query here"

Or (if you want to use multiple lines for your query):

ask
...
<enter>

On the enter after an empty line, your multi-line query will be sent to Jef, who will return with a response shortly 😁.

NOTE: Form multi-line queries quotation marks ("") are not needed!

Each response is saved in a unique file (referred to as a session) in the $XDG_CACHE_HOME directory.

Flags

Set a desired model:

ask -m <model_name> "your query here"

NOTE: The model name should correspond to the model in your LocalAI/models/ directory.
NOTE: It is also possible to set the desired model in $XDG_CONFIG_HOME/ask-jef/ask.env.

To submit contents of files:

ask -f <file_1> -f <file_2> "your query here"

To save a response under a desired session name:

ask -s <session_name> "your query here"

NOTE: The above command could also be used to continue from where you left off in a previous session.

To list the available sessions:

ask -ls

To print the results of a session:

ask -cat <session_name>

To delete a session:

ask -rm <session_name>

To rename a session:

ask -mv <old_session_name> <new_session_name>

---