Circuit-Forge/peregrine
2
0
Fork 0
Code Issues 22 Pull requests 2 Projects Releases 6 Packages Wiki Activity Actions

docs: update README — manage.sh CLI reference + correct Forgejo clone URL

Browse source
This commit is contained in:
pyr0ball 2026-02-25 16:59:34 -08:00
parent ca278d5b41
commit 04915d33be
1 changed files with 36 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -11,10 +11,10 @@ Privacy-first, local-first. Your data never leaves your machine.
## Quick Start
**1. Install dependencies** (Docker, NVIDIA toolkit if needed):
**1. Clone and install dependencies** (Docker, NVIDIA toolkit if needed):
```bash
git clone https://git.circuitforge.io/circuitforge/peregrine
git clone https://git.opensourcesolarpunk.com/pyr0ball/peregrine
cd peregrine
bash setup.sh
```
@ -22,14 +22,22 @@ bash setup.sh
**2. Start Peregrine:**
```bash
make start # remote profile (API-only, no GPU)
make start PROFILE=single-gpu # with one GPU
make start PROFILE=dual-gpu # dual GPU (Ollama + vLLM)
./manage.sh start # remote profile (API-only, no GPU)
./manage.sh start --profile cpu # local Ollama on CPU
./manage.sh start --profile single-gpu # Ollama + Vision on GPU 0
./manage.sh start --profile dual-gpu # Ollama + Vision + vLLM (GPU 0 + 1)
```
Or use `make` directly:
```bash
make start # remote profile
make start PROFILE=single-gpu
```
**3.** Open http://localhost:8501 — the setup wizard guides you through the rest.
> **macOS:** Docker Desktop must be running before `make start`.
> **macOS:** Docker Desktop must be running before starting.
> **Windows:** Not supported — use WSL2 with Ubuntu.
---
@ -99,6 +107,28 @@ Connect external services in **Settings → Integrations**:
---
## CLI Reference (`manage.sh`)
`manage.sh` is the single entry point for all common operations — no need to remember Make targets or Docker commands.
```
./manage.sh setup Install Docker/Podman + NVIDIA toolkit
./manage.sh start [--profile P] Preflight check then start services
./manage.sh stop Stop all services
./manage.sh restart Restart all services
./manage.sh status Show running containers
./manage.sh logs [service] Tail logs (default: app)
./manage.sh update Pull latest images + rebuild app container
./manage.sh preflight Check ports + resources; write .env
./manage.sh test Run test suite
./manage.sh prepare-training Scan docs for cover letters → training JSONL
./manage.sh finetune Run LoRA fine-tune (needs --profile single-gpu+)
./manage.sh open Open the web UI in your browser
./manage.sh clean Remove containers, images, volumes (asks to confirm)
```
---
## Developer Docs
Full documentation at: https://docs.circuitforge.io/peregrine