`QUICKSTART.md`

38 lines
# jev (jev-ultrafast) — Quickstart

Installed: 2026-09-20 · `~/Projects/jev-ultrafast` · cloned from github.com/browser-use/jev-ultrafast (MIT)

**What it is:** a browser agent that *chooses* an action from a numbered, indexed list of on-page
elements instead of generating selectors/code. One natural-language goal in → it clicks/types/scrolls
to completion. Minimal LLM use (only for typing text).

## Status
- [x] Cloned + `uv sync` (22 pkgs, Python 3.13 venv) — `jev` binary built & confirmed
- [x] `.env` scaffolded from `.env.example`
- [ ] **API keys** — required before it can run (see below)

## Step 1 — add the two keys to `.env`
```
TYPESAFE_API_KEY=      # JEV / browser-use "typesafe" model
TEXT_MODEL_API_KEY=    # OpenRouter key (Gemini/GLM/DeepSeek also work via OpenAI-compatible base URL)
```

## Step 2 — run (all commands are `!` pastes — classifier-gated for the agent)
```bash
# demo inspector (opens http://127.0.0.1:8766 → "Start demo → Run automatically")
uv run --project ~/Projects/jev-ultrafast jev

# one-off goal against a URL
uv run --project ~/Projects/jev-ultrafast --env-file ~/Projects/jev-ultrafast/.env \
  python examples/run.py --url "https://example.com" --goal "your narrow goal here"

# check Chrome connection
uv run --project ~/Projects/jev-ultrafast browser-harness --doctor
```

## Notes
- Needs Chrome with remote debugging (allow when prompted by browser-harness).
- Keep goals *narrow*; repeat `--goal` for an ordered list.
- A "DONE" from the agent is not proof of success — verify the real outcome (per AGENTS.md).
- Dev checks: `uv run ruff check .` · `uv run pytest` · `uv build`.