Documentation and installation.

Complete reference for installing Varynth across Windows PowerShell, Linux, macOS, Node.js, and Rust, plus full CLI commands, multi-agent swarm orchestration, personal vk_live_ API keys, cloud session sync, and gateway operations.

Quick platform installer

Select your OS or package manager and click to copy

PowerShell 5.1 / 7+ (x86_64-pc-windows-msvc)
PS C:\>irm https://varynth.zuzia.dev/install.ps1 | iex

Native Windows bootstrapper using Invoke-RestMethod (irm) piped to Invoke-Expression (iex). Automatically provisions varynth.exe into %USERPROFILE%\.local\bin and updates PATH.

PS>varynth install --startup
Optional: register background tray & startup launcher
PS>varynth --model varynth/gpt-oss-120b
Launch full-screen TUI immediately with zero API key setup

1. Installation methods

Windows PowerShell (irm), Linux/macOS (curl), Node.js, and Rust

Windows (PowerShell irm)

windows

One-line PowerShell bootstrapper using Invoke-RestMethod (irm) piped to Invoke-Expression (iex). Detects Node.js or Cargo automatically and installs the native varynth.exe binary.

PowerShell 5.1 / 7+x86_64-pc-windows-msvc
PS C:\>irm https://varynth.zuzia.dev/install.ps1 | iex
persistvarynth install --startup
verifyvarynth --version

Linux and macOS (curl | sh)

posix

Standard POSIX shell bootstrapper for Ubuntu, Debian, Arch, Fedora, and macOS (Apple Silicon & Intel). Installs via global npm if available or builds a release binary with Cargo.

bash / zsh / shlinux & darwin
$curl -fsSL https://varynth.zuzia.dev/install.sh | sh
binaryvarynth install (~/.local/bin/varynth)
verifyvarynth doctor

Node.js (npm / pnpm / bun)

recommended

Cross-platform distribution on npm (@zuziadev/varynth). Ships the pre-compiled Windows binary directly and triggers an automated cargo build --release postinstall hook on Linux and macOS.

Node.js >= 18@zuziadev/varynth
npmnpm i -g @zuziadev/varynth
pnpmpnpm add -g @zuziadev/varynth
bunbun add -g @zuziadev/varynth

Rust Toolchain (Cargo & Source Build)

cargo

Build the native Rust CLI directly from the repository with full LTO optimizations and copy the binary to ~/.local/bin/varynth (or %USERPROFILE%\.local\bin\varynth.exe on Windows).

rustc >= 1.80 (stable)cli/Cargo.toml
git + cargocargo install --git https://github.com/ZuziaDev/varynth.git varynth
local buildcargo build --manifest-path cli/Cargo.toml --release
self-install./cli/target/release/varynth install

System requirements

specs

Varynth runs natively without container overhead unless --sandbox docker-isolated is explicitly selected.

  • OS: Windows 10/11, Ubuntu/Debian/Arch/Fedora, macOS 13+
  • Node.js 18+ (for npm wrapper & MCP stdio servers)
  • Rust 1.80+ (only when building from source on Linux/macOS)
  • Optional: Playwright + FFmpeg for 60fps motion-fream studio

2. First launch & authentication

Zero-auth public models vs. Loopback PKCE account login

Immediate launch (no account required)

Running varynth in any project directory starts the full-screen Terminal UI connected to 21 verified Varynth public models (varynth/gpt-oss-120b, varynth/qwen3.8-27b, varynth/nemotron-3-120b-a12b, varynth/deepseek-r1-distill-qwen-32b, and more).

$ cd ~/your-project && varynth
$ varynth exec "explain the architecture of this repo"

Account login & tiered skills sync

Sign in with varynth login to complete an RFC 7636 OAuth 2.0 PKCE S256 handshake. This unlocks higher daily quotas, web search, Flux image synthesis, and automatic sync of Free and Pro skills from /v1/catalog/skills.

$ varynth login
$ varynth doctor

3. CLI subcommands reference

Every subcommand built into the varynth binary

  • varynth [repl]Launch the interactive full-screen Terminal UI (or --plain for readline mode).core
  • varynth exec "<prompt>"Non-interactive one-shot execution (--output text | json | stream-json).automation
  • varynth swarm "<task>"Orchestrate 3 specialized cognitive agents (Architect, Builder, Reviewer) in sequence.swarm
  • varynth review [--staged]Run an automated security, concurrency, and architecture audit on Git diffs.audit
  • varynth syncSynchronize local .varynth/sessions/ transcripts to your cloud dashboard console.cloud
  • varynth resume [<session-id>]Resume the latest session or match any full/prefix session UUID after Ctrl+C exit.session
  • varynth sessions [fork | export]List saved sessions, branch a session at message N, or export redacted Markdown/JSON.session
  • varynth login / logoutAuthenticate via browser PKCE flow and sync Free/Pro skills to ~/.varynth/skills/.auth
  • varynth endpoint [add | list | remove]Attach an OpenAI- or Anthropic-compatible custom endpoint; keys stay in OS keyring.byok
  • varynth account [connect | disconnect]Connect official provider accounts (OpenAI, Anthropic, Google, Cloudflare Workers AI).byok
  • varynth skill [list | search | install]Manage local skills in .varynth/skills/ and install community skills from skills.sh.skills
  • varynth plugin [list | install | remove]Provision curated MCP plugins (github, gitlab, slack, notion, memory, git, sentry).mcp
  • varynth mcp [status | probe | ping | serve]Inspect configured MCP servers, probe tool schemas, or run the stdio MCP bridge.mcp
  • varynth serve [--host --port]Start the local operator web deck (port 7420) and OpenClaw Telegram gateway poller.gateway
  • varynth computer [status | doctor | enable]Configure desktop control with DPI-aware coordinate overlay and Esc kill-switch.operator
  • varynth doctor [--fix]Run comprehensive health checks across sandbox enforcement, auth, proxy, and MCP.diagnostics

4. Interactive TUI slash commands & role routing

oh-my-pi split /model selector and 7 specialized cognitive roles

Split-pane /model browser & 7 role bindings

Typing /model inside the TUI opens a two-pane browser with provider filtering on the left, capability tabs (all, chat, tiny, image, tts, stt, judge, rerank) on the right, and instant keys (1-7 or d/p/s/a/w/m/f) to bind distinct models to each cognitive role:

  • default (key 1 / d): Primary coding and tool-calling driver.
  • plan (key 2 / p): High-reasoning architect used in plan mode and /plan.
  • smol (key 3 / s): Fast model for /compact context summarization and auto-titling.
  • advisor (key 4 / a): Verification auditor for /review and /goal completion checks.
  • widget (key 5 / w) & memory (key 6 / m): UI generation and /seance vault indexing.
  • fallback (key 7 / f): Automatic failover model retried transparently if the primary provider errors.
/model → Tab switch pane · Alt+Left/Right filter kind · 1-7 bind role · Enter select

Essential TUI slash commands

Every interactive workflow is accessible without leaving the keyboard:

  • /plan & /goal: Structured planning and autonomous multi-turn goal loops.
  • /undo & /redo: Revert or restore file checkpoints step by step.
  • /compact & /context: Inspect token budget and compact earlier turns.
  • /skills & /mcp: Browse, preview, and install skills or probe MCP servers.
  • /btw <note>: Inject a live side-note into a running agent turn without stopping it.
Shift+Tab cycle permission mode · Ctrl+V paste

5. Subsystems: Memory Vault, Telegram & Studio

Obsidian vault identity, OpenClaw gateway, and Flux 60fps video

Soul identity & Obsidian MEMORY/ vault

Varynth maintains five deep persona files in .varynth/ (SOUL.md, AGENT.md, HEART.md, DREAM.md, USER.md) alongside a structured Obsidian vault at .varynth/MEMORY/ (index.md, daily/, concepts/, decisions/) with native [[wikilink]] resolution.

.varynth/MEMORY/index.md → [[concepts/flux-pipeline]]

OpenClaw Telegram gateway

When running varynth serve with a configured telegram_bot_token and telegram_allow_from allowlist, Varynth accepts remote commands (/help, /status, /model, /todo, /undo, /redo, /clear, /revoke), ingests photos and documents, and sends interactive inline approval buttons (Approve Once, Always Approve, Deny).

$ varynth serve --host 127.0.0.1 --port 7420

Flux image synthesis & motion-fream 60fps

Authenticated accounts can invoke POST /v1/images/generations across 5 worker gateways or use the interactive Flux Studio inside the Dashboard Console. Combined with motion-fream-pro, Varynth synthesizes hero assets and encodes deterministic 60fps MP4 launch videos via Playwright and FFmpeg.

generate_image → Playwright virtual clock → FFmpeg

6. Multi-agent swarm, personal API keys & HTTPS provisioning

3-agent parallel orchestration, vk_live_ tokens, Git diff review, and Let's Encrypt

Multi-agent swarm & Git review

cli swarm

varynth swarm "<task>" dispatches your task through three specialized cognitive roles in sequence: Architect (roles.plan), Builder (roles.default), and Security Reviewer (roles.advisor). Use varynth review --staged before committing to catch race conditions and regressions.

$ varynth swarm "Implement rate-limited token bucket in Rust"

Personal API keys (vk_live_...)

bearer auth

Mint long-lived vk_live_... tokens in your Dashboard Command Console. Only the SHA-256 digest is stored in PostgreSQL, and keys work everywhere Authorization: Bearer vk_live_... is accepted: OpenAI SDKs, Cursor, Continue, CI workflows, and varynth sync.

Authorization: Bearer vk_live_9f8a7b6c5d4e3f2a1b0c...

Automated Let's Encrypt HTTPS

tls / ssl

Provision automatic Let's Encrypt TLS certificates, HTTP/2, HSTS, and updates to PUBLIC_ORIGIN and NEXT_PUBLIC_SITE_URL on your VDS with a single idempotent command.

# bash /opt/varynth/deploy/enable-https.sh varynth.yourdomain.com [email protected]