OpenViSTAI · Agents · Blockchain · Crypto
Submit a project
Menu
AI Developer Tools & SDKs

Awful Jade

Awful Jade (`aj`) is a Rust command-line client for working with large language models through OpenAI-compatible APIs. It supports single prompts, interactive conversations, session memory, prompt templates and retrieval-augmented questions using local files. The README also describes OCR text cleanup and exam-question synthesis as terminal use cases.

Explore the practical guide ↓

Independent OpenViST project profile, based on linked sources.

Awful Jade — OpenViST project profile in AI Developer Tools & SDKs.
OpenViST project illustration. See the linked sources for product details.
Understand the project

Practical overview

When it fits

Use Awful Jade when you want to work with a configured OpenAI-compatible model from the command line, especially for prompt-based tasks or questions grounded in local files.

Who it is for

  • Developers and other terminal users who want to send prompts to an OpenAI-compatible model API.
  • Users who want to query local documents as context or maintain interactive sessions.

Documented uses

  • Ask a one-off question or conduct a REPL-style model conversation.
  • Use files as retrieval context for a question or summary.
  • Clean up OCR-extracted text or synthesize exam questions with an LLM.
Before you choose

Requirements & limits

Installation is documented with `cargo install awful_aj` and requires Rust. The public GitHub repository specifies the CC-BY-SA-4.0 license.

  • The user supplies the API base, key and model through configuration; the tool is a client rather than a model-hosting service.
  • Features using embeddings download all-MiniLM-L6-v2 from HuggingFace Hub when first needed.
  • The README documents session storage in a SQLite database and options for standalone prompts, named sessions and file-based retrieval.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Install and initialize Awful Jade

Install the `aj` command and create its default configuration, templates and session database.

Before you start

  • Rust
  • A terminal

Steps

  1. Install the binary with the command below.

    Documented command
    cargo install awful_aj

  2. Run aj init to create the default configuration, templates and SQLite session database.

Expected outcome

The `aj` command is installed and its initial configuration files and database are created in the platform configuration directory.

Guide limitations

  • This covers installation and initialization only; using the CLI also requires configuring a model API.
Documentation 1 ↗
Source-based practical guide

Ask a question with file-based context

Send a prompt with local files supplied as retrieval context.

Before you start

  • Awful Jade installed and initialized
  • A configured OpenAI-compatible API and model
  • Files or a directory to use as context

Steps

  1. Pass files or a directory with -r or --rag and add a question, for example aj ask -r docs/ "What does this project do?".

  2. Optionally set the number of retrieved chunks with -k or --rag-top-k.

Expected outcome

Awful Jade retrieves relevant document chunks and injects them into the prompt context for the model response.

Guide limitations

  • The embeddings model is downloaded from HuggingFace Hub when first needed.
  • Responses depend on the configured model and API.
Documentation 1 ↗
Evidence and transparency

Sources & review

Official repository ↗
Source record details
Source availability
Active
Sources checked
16 October 2026
Original website title
graves/awful_aj · Official homepage title · retained in its source language
How we review sourcesSuggest a correction