Metadata-Version: 2.4
Name: vortex-agent-cli
Version: 0.1.1
Summary: Art-forward terminal AI agent with OpenAI-compatible tools and an aurora TUI.
Author: Jagdeep Singh
Project-URL: Homepage, https://github.com/jagdep-singh/VORTEX
Project-URL: Repository, https://github.com/jagdep-singh/VORTEX
Project-URL: Issues, https://github.com/jagdep-singh/VORTEX/issues
Keywords: ai-agent,cli,coding-agent,terminal,tui,rich
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: click>=8.1
Requires-Dist: httpx>=0.27
Requires-Dist: openai>=1.0
Requires-Dist: platformdirs>=4.0
Requires-Dist: prompt_toolkit>=3.0
Requires-Dist: pydantic>=2.0
Requires-Dist: python-dotenv>=1.0
Requires-Dist: rich>=13.0
Requires-Dist: tiktoken>=0.7
Requires-Dist: tomli>=2.0; python_version < "3.11"

# VORTEX

VORTEX is an art-forward terminal AI pair‑programmer: OpenAI‑compatible brain, aurora TUI skin, live tools, and a workspace‑aware memory so it actually helps you ship.

## Highlights
- Streamed replies in a sculpted Rich TUI with animated gradients and structured tool cards.
- Real tools: read/write/edit files, shell, search, symbol index, MCP servers, checkpoints, and sessions.
- Workspace‑aware: picks a working directory first, reloads config/tools per project, remembers recents.
- Model aware: provider profiles, live model discovery, health probes, and buckets (working/quota/not working).
- Safe by default: approval modes, loop detection, compact workspace snapshot, and a lightweight code index.

## Install
- Best: `pipx install vortex-agent-cli`
- Local checkout: `python3 -m pip install . --no-build-isolation`
- One-shot dev env: `./scripts/install.sh`

## Update
- Standard install: `vortex --update`
- Editable/local checkout: pull latest git instead (the app will tell you).

## Run
- Interactive: `vortex`
- Single prompt: `vortex "write a hello world program in c"`
- Choose project up front: `vortex --cwd /path/to/project`
- Inside the app, `/cwd` switches projects and rebuilds context.

## Configure
Put `.ai-agent/config.toml` in your project:
```toml
active_model_profile = "openrouter"

[models.openrouter]
base_url = "https://openrouter.ai/api/v1"
api_key_env = "OPENROUTER_API_KEY"

[models.openrouter.model]
name = "openrouter/free"
temperature = 0
max_output_tokens = 8192
```

First run will prompt for provider URL and API key and store them in your workspace `.env`. Use `/config` anytime to see the resolved profile, base URL, key source, and model.

Gemini via Google’s OpenAI-compatible endpoint:
```toml
[models.gemini]
base_url = "https://generativelanguage.googleapis.com/v1beta/openai"
api_key_env = "GEMINI_API_KEY"

[models.gemini.model]
name = "gemini-2.0-flash"
temperature = 0.2
max_output_tokens = 8192
```

## Core commands
- `/models [refresh]` – list or probe models for all profiles.
- `/model <name|number>` – switch profile or pick a discovered model.
- `/config` – show resolved settings.
- `/api-change` – re-enter provider URL and API key (restarts the session).
- `/scan` and `/index` – refresh workspace snapshot and symbol index.
- `/save`, `/sessions`, `/resume`, `/checkpoint`, `/restore` – persistence.
- `/tools`, `/mcp` – inspect tools and MCP servers.
- `/help` – full reference.

## Docker (optional)
```bash
docker run --rm -it \
  --env-file .env \
  -v "$PWD":/workspace \
  -v vortex-data:/data \
  vortex
```
Add `--cwd /workspace/subdir` if you want a different project inside the container.

## Release
- Version is in `pyproject.toml`.
- CI builds/tests/publishes via `.github/workflows/publish-pypi.yml`.
- Create a GitHub release after bumping the version to publish to PyPI.
- Current version: 0.1.1.

## Progress log (local)
- Working notes for handoff live in `progress_report.txt` (ignored by git).

## Shape of the repo
- `main.py` – CLI entry.
- `ui/tui.py` – aurora terminal UI.
- `agent/` – agent loop, events, persistence.
- `tools/` – builtin tools, discovery, registry, MCP.
- `context/` – workspace snapshot, code index, compaction.
- `utils/` – credentials, versioning, discovery helpers.
- `workspace/` – default scratch project.
