Skip to content

Latest commit

 

History

History
112 lines (75 loc) · 3.38 KB

README.md

File metadata and controls

112 lines (75 loc) · 3.38 KB
Raw

arey

Arey (अरे, sanskrit) — ind. Interjection of calling.

Arey is a simple large language model playground in your terminal.

  • ✨ Command line interface, works everywhere python is available.
  • 🤖 Use any llama.cpp, ollama model or an openai compatible endpoint.
  • 💬 Chat with your favorite local models. CPU friendly 🍀
  • 🙋 Ask anything to AI models with a single command.
  • 📋 Supercharged prompt fine-tuning workflow ❤️ Edit your prompt in any editor and arey will generate a completion on save.
  • 🔓 No telemetry, no internet, nothing to sell.

See Get Started or notes below for a quick guide.

Arey.demo.mp4

🚧 See Roadmap below.

Installation

# Install pipx if needed: `pip install pipx`
# Ensure ~/.local/bin is available in system PATH
pipx install arey

Windows troubleshooting notes are here.

Usage

❯ arey --help
Usage: arey [OPTIONS] COMMAND [ARGS]...

  Arey - a simple large language model app.

Options:
  -v, --verbose BOOLEAN  Show verbose logs.
  --help                 Show this message and exit.

Commands:
  ask   Run an instruction and generate response.
  chat  Chat with an AI model.
  play  Watch FILE for model, prompt and generate response on edit.

On the first run, arey will create a configuration file in following location:

  • ~/.config/arey/arey.yml for Linux or Mac systems.
  • ~/.arey/arey.yml for Windows.

Please update the models section in the config yml to your local model path.

1. Ask Arey something!

arey ask "Who is Seneca? Tell me one of his teachings"

2. Chat with Arey

arey chat

3. Run Arey in play mode

Use to fine-tune a prompt in your editor while arey keeps completing your prompt on every save.

❯ arey play /tmp/arey_playzl9igj3d.md

Welcome to arey play! Edit the play file below in your favorite editor and I'll generate a
response for you. Use `Ctrl+C` to abort play session.

Watching `/tmp/arey_playzl9igj3d.md` for changes...

───────────────────────────────────── 2024-01-21 17:20:01 ──────────────────────────────────────
✓ Model loaded. 0.57s.

Life is short because it passes by quickly and can end at any moment. We should make the most of
our time here on earth and live a virtuous life according to stoicism.

◼ Canceled.

Watching `/tmp/arey_playzl9igj3d.md` for changes...

Development

See https://apps.codito.in/arey/contribute.

Roadmap

  • Chat and task modes for interactive or batch queries
  • Define new tasks with only a prompt, no code. See docs/samples directory for examples.
  • Markdown formatting for chat mode.
  • Ollama support.
  • OpenAI server support.
  • Command support in chat. E.g., logs, change model, copy, clear, etc.
  • Discover prompts from user directory
  • Manage prompts and create new interactively
  • Download models and manage them
  • Release v0.1
  • Add textfx
  • Add offline knowledge bases and RAG. See https://library.kiwix.org/#lang=eng

License

MIT