# Project pack: Vane (formerly Perplexica) @ 348feca

Facts about **Vane (formerly Perplexica)** for an AI following the [BespokeAI handover guide](https://handoff.bespokeai.software/guide/v4.md). Pinned to one version; never changes after publication.

> Vane (until recently called Perplexica) works like Perplexity: you ask a question in plain words, it searches the web privately through its own built-in SearXNG, reads the pages and writes an answer with numbered sources. It can also search discussions or academic papers, look at files you upload, and show images, videos, weather and news. Use a free local model through Ollama or your own key for OpenAI, Claude, Gemini or Groq.

## Setup path (checked 2026-11-03)
- **Needs Docker.** Tell the person before any setup work; no light non-Docker route is documented upstream. A non-Docker install exists but needs your own SearXNG; judged too heavy for a one-sitting non-technical setup. Docker Desktop on Windows may need a computer restart and an admin-only Windows feature (virtualisation); say so and let the person decide.
- Verdict source: https://raw.githubusercontent.com/ItzCrazyKns/Vane/HEAD/README.md
- You may be unable to download source archives or run commands in this session. The person downloads and runs things; if you cannot fetch something, give any changed file in full in chat with its path.

## Version and source
- Repository: https://github.com/ItzCrazyKns/Vane
- Pinned commit: `348feca3e378fb4157b217724ed508dc707f853f`. Use exactly this version.
- Zip the person can download in a browser: https://github.com/ItzCrazyKns/Vane/archive/348feca3e378fb4157b217724ed508dc707f853f.zip
- Fresh checkout (only if you have a shell and git): use the commands below in an empty folder. If this exact source is already checked out, keep your branch and use the development command; do not clone again or reset local changes.
- Official docs: https://github.com/ItzCrazyKns/Vane/tree/348feca3e378fb4157b217724ed508dc707f853f/docs
- Licence: **MIT**. Very permissive. You can use, change and share it, even commercially, as long as you keep the copyright notice. No obligation to publish your changes.

## Commands from the pinned source
- Developer commands (they may use Docker):

  ```sh
  git clone https://github.com/ItzCrazyKns/Vane bespoke-perplexica
  cd bespoke-perplexica
  git checkout --detach 348feca3e378fb4157b217724ed508dc707f853f
  # Prepare development requirements and local configuration first.
  # Setup notes: http://localhost:3000; needs a SearXNG with JSON output enabled (set its URL in settings or SEARXNG_API_URL)
  npm i && npm run dev
  ```

- Separate trial of the current upstream release (not your changes; sample data and a separate data directory only):

  ```sh
  docker run -d -p 3000:3000 -v vane-data:/home/vane/data --name vane itzcrazykns1337/vane:latest # then open http://localhost:3000 and add your model provider (Ollama, OpenAI, Anthropic…) in the setup screen
  ```
- Tools these commands use: Docker (the image includes SearXNG), or Node.js with your own SearXNG instance, An AI provider key, or Ollama / LM Studio / Lemonade running locally
- Develop: `npm i && npm run dev   # http://localhost:3000; needs a SearXNG with JSON output enabled (set its URL in settings or SEARXNG_API_URL)`
- Check/lint: `npm run lint`
- Build: `npm run build`
- Stack: typescript (Next.js 16, React, Tailwind CSS, Drizzle ORM). Difficulty for a non-developer with an AI: **moderate**. A single, small Next.js app (about 240 files) with clear folders for the search pipeline, prompts, widgets and model providers. Models, theme, units and personal instructions are set in the app's settings screen. Code changes only need Node and npm; there are no automated tests.
- The project's own AI instructions, in the repository: `CONTRIBUTING.md`, `docs/architecture/README.md`.
Personal data: **yes**. Stored in: Search history and chats in SQLite (data/db.sqlite), settings and API keys in data/config.json, and uploaded files under the data folder. In Docker all of this is in the vane-data volume (/home/vane/data). Secrets are entered by the person, never in chat.

---
Later, only when a step needs it: [reference.md](https://handoff.bespokeai.software/p/perplexica/348feca/r3/reference.md) (customisation points, must-keep-working, data and costs, coding conventions) · [hosting.md](https://handoff.bespokeai.software/p/perplexica/348feca/r3/hosting.md) (long-term hosting; hosts are paid third parties) · [bespoke.yaml](https://handoff.bespokeai.software/p/perplexica/348feca/r3/bespoke.yaml) · [SKILL.md](https://handoff.bespokeai.software/p/perplexica/348feca/r3/SKILL.md)