Skip to main content

AI-powered terminal coding assistant — build, debug, refactor and ship code faster

Project description

⚡ Vital — AI-Powered Terminal Coding Assistant

PyPI Version Python Versions License Downloads

Build, debug, refactor and ship code faster — all from your terminal.
Powered by your choice of AI: Groq, OpenAI, Claude, or Gemini.


🚀 Install

pip install vital-cli

Then run:

vital

That's it. No config files, no setup scripts — just run vital and go.


✨ Features

🤖 Multi-Provider AI Support

Use any combination of AI providers you have keys for:

  • Groq — Ultra-fast, free tier available
  • OpenAI — GPT-4o for complex reasoning
  • Anthropic — Claude for code review and quality
  • Google — Gemini for large context tasks
vital setup   # add your API keys
vital status  # see what's configured

🧠 Agent Mode — Build Full Projects Automatically

Just describe what you want. Vital plans, builds, runs and fixes it:

vital  build me a flask todo app with login

Vital will:

  1. Plan all files needed
  2. Generate each file completely
  3. Install dependencies
  4. Run and test the project
  5. Auto-fix any errors found

💬 Interactive Mode with Memory

Vital remembers your conversation and project preferences:

vital                          # launch interactive mode
vital --resume                 # resume last session

Inside Vital:

vital › create a calculator with html css js
vital › now add dark mode to it       ← remembers context
vital › make the buttons bigger       ← still remembers

📁 Project Memory (VITAL.md)

Rules that persist across every session:

/memory init                    create VITAL.md for this project
/memory add "always use TypeScript"
/memory add --global "I prefer Flask over Django"
/memory show                    see what Vital remembers

🛠️ Powerful Commands

Command What it does
vital debug Analyze errors and suggest fixes
vital fix <file> Fix issues in a file using AI
vital refactor <file> Improve code quality
vital test <file> Generate unit tests
vital doc <path> Generate documentation
vital commit Auto-generate git commit messages
vital explain <file> Explain code in plain English
vital init <type> Generate project boilerplate
vital agent "build X" Full autonomous project builder

⚙️ Setup

Basic (Groq only — free tier available)

pip install vital-cli
vital setup
# Enter your Groq API key from console.groq.com
vital

With all providers

pip install "vital-cli[all]"
vital setup
# Add any keys you have — skip ones you don't

Install specific providers

pip install "vital-cli[openai]"     # + OpenAI
pip install "vital-cli[anthropic]"  # + Claude
pip install "vital-cli[gemini]"     # + Gemini
pip install "vital-cli[all]"        # everything

🎮 Usage

Interactive Mode

vital                    # start
vital --resume           # resume last session
vital --version          # show version

Inside Vital — Slash Commands

/help          show all commands
/memory init   create project memory file
/memory add    add a rule to memory
/history       show session history
/resume        load a previous session
/providers     manage your AI providers
/agent         launch agent mode
/context       show project context
/clear         clear screen
/exit          quit

Direct Commands

vital debug --file app.py
vital debug --error "TypeError: cannot read..."
vital fix app.py --issue "function returns wrong value"
vital refactor app.py
vital test app.py
vital doc .
vital commit --push
vital explain app.py --simple
vital init flask-api --name myproject
vital agent "a react weather app"

🏗️ Project Structure

After pip install vital-cli, your project can use a VITAL.md file for persistent memory:

# Vital Project Memory
## Coding Rules
- Always use TypeScript
- Use Tailwind CSS for styling
- Follow REST API conventions

Vital reads this automatically every session — no need to repeat yourself.


🔑 Getting API Keys

Provider Free Tier Get Key
Groq ✅ Yes console.groq.com
OpenAI ❌ Paid platform.openai.com
Anthropic ❌ Paid console.anthropic.com
Google Gemini ✅ Yes aistudio.google.com

Recommended for beginners: Start with Groq — it's free, fast, and works great.


🤝 Contributing

git clone https://github.com/yourusername/Vital-CLI
cd Vital-CLI
python -m venv venv
source venv/bin/activate   # Windows: venv\Scripts\activate
pip install -e ".[all]"
vital

Pull requests welcome! Check the issues page for things to work on.


📄 License

MIT License — free to use, modify and distribute.


Built with ❤️ for developers who live in the terminal.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vital_cli-0.2.0.tar.gz (51.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vital_cli-0.2.0-py3-none-any.whl (59.7 kB view details)

Uploaded Python 3

File details

Details for the file vital_cli-0.2.0.tar.gz.

File metadata

  • Download URL: vital_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 51.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for vital_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b771c24639bd5a59e1949b1106f457f48b89d6e6508bffe63cc38a26210dc6a8
MD5 df210e1e6398e392d86153716009be4c
BLAKE2b-256 f74bf22ae982e0e6ba319753193d6cfd61da77dc8a23f06e64bd34e8179ae7bc

See more details on using hashes here.

File details

Details for the file vital_cli-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: vital_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 59.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for vital_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 32ec03cd4d18e5534552025faadba60c13b34a158b0ce3dbc1d759dde552fb37
MD5 aacda7eb4b2deae78ca0c2b4d5bd5495
BLAKE2b-256 ba8e5ce127c2d94368d4fc6f48cca2c6a469dc0a0c6bbf13bc90b4b69858c1a3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page