jade
EN
GitHub Install

Download

Download jade

There is no GitHub release and no Docker image: jade is a desktop app. You build the installer on Windows, then run it.

  1. Build the installer

    The output is dist\installer\Jade-Setup-<version>.exe.

    $ git clone https://github.com/yetysw/jade.git && cd jade
$ python -m venv .venv
$ .venv\Scripts\activate
$ pip install -e .[dev]
$ cd flutter_app && flutter build windows --release && cd ..
$ python -m PyInstaller jade.spec --noconfirm
$ "%LOCALAPPDATA%\Programs\Inno Setup 6\ISCC.exe" installer\jade.iss

  2. Run it as administrator

    The wizard asks for the address of the inference server, the Cloudflare Access client ID and secret, and optionally the address of a SearXNG service. They are written to a local .env, never into the installer.

  3. Start jade

    On the first launch it downloads the search models (about 3.2 GB, once) into C:\ProgramData\Jade\models, then asks you to accept the terms.

  4. Add your folders

    Open the settings (gear icon), add the folders or network drives to index, and ask a question.

The installer is not code-signed, so SmartScreen shows an unknown publisher. Read what jade protects and what it does not first.

Requirements

  • Windows 10 or 11, x64
  • An inference server reachable over HTTPS (Ollama behind Cloudflare Access), with its client ID and secret
  • About 3.2 GB of free disk space for the search models
  • To build: Python 3.12 or later, the Flutter SDK (stable channel, Windows desktop enabled) and Inno Setup 6

Versions and paths

  • Version in the repository1.10.1
  • GitHub releasesNone yet
  • Docker imageNone, it is a desktop app
  • Local address127.0.0.1
  • Conversations%LOCALAPPDATA%\Jade
  • Shared index, logs and modelsC:\ProgramData\Jade

Support the project

jade is MIT licensed. If it saves you time, you can support its development.

Sponsor us on GitHub