This fork adapts Vane into a Nimi ecosystem App. The standalone Nimi App targets Windows x64 and Apple Silicon macOS. Availability in the Nimi catalog requires a separately approved Registry entry.
Vane owns research steps, web tools, document retrieval and answer presentation. Nimi owns account binding, App authorization, model configuration and AI consumption. Chat history, uploaded documents and search settings use Nimi managed App storage.
The release target is installation and launch from Nimi. Once installed, sign in to Nimi and open Vane:
- Open Settings → AI models and use Nimi's model configuration panel. Research needs a text model with tools and structured output support; document indexing and search ranking also use text embeddings.
- Open Settings → Search, enter a SearxNG service address, test it and save. The service must allow JSON searches. This App does not bundle a SearxNG server or promise a default public endpoint.
- Ask a question, choose web/academic/social sources and a research mode, or attach a PDF, DOCX or plain text document. Documents are limited to 20 MiB each, with at most 20 selected documents.
Settings are entered inside the App. End users do not edit repository files, install Node.js or run a Vane web server. Search queries go to the configured search service; AI execution follows the configuration owned by Nimi.
Search-engine outages are reported with a retry or service-selection action. Quality mode uses deeper research while keeping the answer length appropriate to the question.
Research can be stopped. Reopening a chat within the running Host observes its current progress without repeating tools. After a Host exit, an unfinished saved request is shown as interrupted; it is not automatically resumed.
Changing text-generation settings does not require re-uploading documents. If the embedding model changes, clear the old attachments and upload them again to rebuild their indexes. Interrupted answers remain incomplete; a connection failure never confirms that unsaved progress was stored.
Upstream is ItzCrazyKns/Vane, with baseline
348feca3e378fb4157b217724ed508dc707f853f before the Nimi adaptation. The downstream
App mainline is nimi, independent of upstream release tags. Select an exact
upstream revision when updating and review the affected product, dependency,
license, CI and agent-entry changes together; do not automatically import tags
or restore retired provider/account paths.
Use Node.js 24 and the pnpm version declared in package.json. This branch uses
published SDK 0.12.0, Kit/native 0.8.0 and App Tools 0.5.3, with nimi-coding pinned
to 0.6.3. The SDK and Kit releases came from Nimi main
9c82151fba95f6397e8b068551208487300343bb. Install from the checked-in public
lockfile; local tarballs and parent-checkout overrides are not release inputs.
The public macOS native carrier uses the production Runtime trust profile. Platform-source experiments use Nimi's separately documented development carrier/profile and remain private validation. A matching version number alone does not make the two native profiles interchangeable.
The project uses the managed engineering surface and is maintained with nimi-app sync. App Tools also supports nimi-app init --adopt for first-time adoption of an existing project. This fork has no fresh scaffold intent or lock; do not fabricate them.
pnpm install --frozen-lockfile
pnpm exec nimi-app check
pnpm exec nimi-app test
pnpm run typecheck
pnpm devpnpm dev is the official App Tools entrypoint. Run a matching installed Nimi,
sign in and enable developer mode. App Tools asks Desktop to supervise the
Electron Host and prints its loopback CDP endpoint. Nimi's source-development
Runtime is a separate native trust profile; follow the platform's development
instructions when working on that profile.
A new development registration has its own managed storage identity. To rebuild and reopen the same App data, run pnpm exec nimi-app dev --list-registrations, select the existing registration for this project, then use pnpm dev -- --resume <selector>. Selectors belong to the current Desktop session; list again after restarting Nimi. Plain pnpm dev creates a new registration. Renderer reload reconnects within the existing Host. Development registration is separate from installed App lifecycle acceptance.
pnpm exec nimi-app check checks the managed authoring contract and public
dependency lock. Run it after synchronization and dependency changes, and before
packaging. Verify real App behavior separately through the supervised Host.
The current Runtime development slice supports the admitted Gemma 4 local configurations and an exact Codex Responses adapter for gpt-5.6-sol, selected through a Nimi-managed Codex connection. Real Codex development checks have exercised tools, structured replies and document retrieval. The claude-sonnet-4-6 Anthropic Messages adapter has protocol tests but no live acceptance yet. Other catalog models are not implicitly covered by these adapters; availability also depends on the connected provider account.
Before the first release, follow the app-tools publishing setup.
Configure NIMI_REPOSITORY_ADMIN_TOKEN in this repository's Actions secrets with
Administration: Read-only. It only checks tag protection and Release
immutability; actual Release uploads use GitHub's built-in token. Local
development does not need this credential. A secret in another App repository
is not inherited.
For an App release, keep the public component combination and lockfile aligned, then run the managed lifecycle:
pnpm exec nimi-app sync
pnpm exec nimi-app check
pnpm exec nimi-app test
pnpm exec nimi-app build --target macos-aarch64 --production
pnpm exec nimi-app pack --target macos-aarch64 --productionRun the commands above on Apple Silicon macOS. On Windows x64, use --target windows-x86_64 for both build and pack. The managed workflow builds both targets on their native runners and aggregates their packages into one Release. Every build executes the packaged Electron binary to check protected-native loading, canvas and real PDF/DOCX extraction; this dependency check does not establish Desktop/Runtime or GUI acceptance.
The --production flag supplies the native execution metadata required by Nimi installation; it does not publish anything. For local installation testing, use Nimi → Apps → Add app → Import local package.
The .gitattributes rule preserves LICENSE bytes on Windows. Registry compares the packaged license with the exact tagged source file; a checkout line-ending conversion also fails this check.
The generated .github/workflows/nimi-app-release.yml owns GitHub package publication. Registry admission and installation through Nimi are separate acceptance steps and remain unverified until actually exercised. No test requires publishing a package, pushing a tag or merging a release PR.
The former Next.js server, direct model provider setup, SQLite and Docker deployment are removed from this fork. Upstream documentation under docs/ describes the original project; it is not the integration contract for this Nimi App.
Vane is MIT licensed. See LICENSE. Original project and contributors: ItzCrazyKns/Vane.
Report the App version, failed operation, Runtime status and error message through this fork’s GitHub issue tracker. Remove credentials, session tokens, document contents and private search queries from reports. Restart Vane from Nimi after checking model and search settings; an interrupted request is not automatically resumed.