@zortexhq/install

Zortex keeps a local, encrypted vault of your own data and works it for you from the command line. Your vault is local and encrypted; nothing leaves your machine except content-free telemetry counts, and only when you elect it.

The unified package targets Windows x64 and macOS 13 or later on Apple Silicon or Intel. The matching platform component is selected by npm during installation.

Mac releases may be ad-hoc signed and not Apple notarized, so macOS may show a security prompt. Automated package checks cover installation, CLI launch and the MCP protocol on Apple Silicon and Intel (Intel may run through Rosetta). They do not verify Codex desktop, first-run macOS permissions, Google consent or live connector reads. Those checks remain unverified unless the release notes provide separate results.

Install

npm install --global @zortexhq/install@latest
zortex --help

The installer brings its own platform-matched Bun runtime; no manual Bun setup is needed. On macOS, first-run onboarding checks the invoking Terminal or agent's effective permissions. If necessary, Zortex.app asks for its own Accessibility and Full Disk Access grants. On Windows, Zortex uses its Windows host path and does not request macOS permissions.

To inspect that decision without creating a vault or starting onboarding:

zortex --probe-only

First run

zortex

With no vault yet at ~/.zortex, a bare zortex starts onboarding through the same host-or-app permission decision.

zortex onboard

zortex onboard walks the sources you want connected (Gmail, Drive, GitHub, Notion, …) and creates the vault. Every run is undoable and every action leaves a trail you can inspect with zortex doctor.

Autopilot

zortex autopilot

zortex autopilot connects every registered source in priority order, then starts the background sync and index catch-up and returns while they finish. (Lands in milestone M4 of the connector-autopilot work order; until then zortex onboard is the entry point.)

Where things live

| What | Where | |---|---| | vault (app root) | ~/.zortex — override with --app-root <dir> or ZORTEX_APP_ROOT | | runtime override | ZORTEX_BUN=<path to Bun> | | help | zortex --help, zortex help <command> |

Privacy

Your vault is local and encrypted. Your content is yours; the learning is everyone's — what leaves is counts, never text.