README.md

Kryten

Kryten is a CLI tool to help you easily ask questions and get clear sourced answers directly from your documents.

./kryten ask ~/directives.pdf question "What's Space Core Directive 997?"

Work done by an officer's doppleganger in a parallel universe
cannot be claimed as overtime. (directives.pdf, page 1)

Goals:

Kryten is portable, snappy, and works across all platforms with minimal resource usage. For real.

• CLI only
• Tiny footprint: Kryten is only 1.6MB.
• SQLite for portability and easy backups.
• Ask any question you want.
• Show your chat history for a single file.
• Show your chat history across all files.
• Documents are cached so questions are snappy.
• Run without ceremony. No need for configurations.

My intent is for Kryten to be used by other apps to power their RAG workflows.

Usage Guide:

Set these three Environment variables:

OPENAI_API_KEY="sk-123123"
PINECONE_API_KEY="123123"
PINECONE_ENDPOINT="https://some-index.svc.some-random-id.pinecone.io"

Call the kryten binary.

./kryten ask ~/directives.pdf question "What's Space Core Directive 997?"

Work done by an officer's doppleganger in a parallel universe 
cannot be claimed as overtime. (directives.pdf, page 1)

Requirements:

OpenAI for ChatPGT

You can create your own API key here: https://platform.openai.com/api-keys

Pinecone Serverless for Vector Database RAG.

Java Runtime to run Tika App.

Tika App is used to extract the content of your documents. You'll need the Java Runtime Environment installed on your machine so this can run properly.

Local Development:

nimble install
nimble build && ./kryten ask ~/directives.pdf question "What is Space Core Directive 196156?"

Contributing:

TODO