Skip to main content

The Zeq CLI

The framework's terminal. The same command surface runs in two places: the native CLI (zeq) in your own terminal, and the workbench terminal inside any node's web UI. Same commands, same envelopes, same vocabulary — what differs is only where credentials live (~/.zeqrc natively, browser storage in the workbench).

Install (native)​

Self-hosted from the framework's own channel — no third party. Every node serves its own zeq binary with a published sha256 pin:

curl -fsSL https://zeqsdk.com/install.sh | sh

The installer downloads /cli/zeq, fetches the origin's published pin from /cli/zeq.sha256, and verifies the download against it before installing — a mismatch aborts with ✗ sha256 mismatch — download corrupted or tampered. Any node works as the origin (zeqsdk.com, zeqstate.com, zeqond.com, zeqapi.com, zeq.dev, or your own fork). Requires Node 18+.

The same installer also wires the TypeScript/JavaScript SDK from Zeq's own npm registry (so you never touch npmjs):

npm config set @zeq:registry https://zeqsdk.com
npm install @zeq/sdk

See @zeq/sdk for the package surface.

Check the install afterwards:

zeq doctor      # origin health, clock drift (in Zeqonds), auth, binary-vs-pin, conformance surface

First contact​

zeq tutorial

The guided 7-step onboarding, action-driven and resumable across sessions: the clock → mint your identity + machine (your account equation) → first compute → verify the receipt → the entangled state → link the SDK → go build. Each step probes live state, so it meets you where you actually are.

The 60-tick version:

zeq signup "kepler orbits traced in winter starlight"   # mints ZID + machine + key; equation shown ONCE — store it
zeq compute NM19 mass=5 acceleration=2                  # signed CKO envelope back
zeq verify                                              # Ed25519 + independent recompute on the last envelope
zeq conformance                                         # prove the node computes the golden physics
zeq sdk                                                 # quickstart wired to YOUR key + this origin

REPL, profiles, completion​

  • Run zeq bare for the REPL — history (↑/↓), Tab completion, themed cards. One-shot zeq <command> works too, with --json for machine-readable output.
  • Profiles store named { key, origin } credential sets — profile use switches the active identity, so one terminal can drive machines on several nodes.
  • zeq completion zsh (or bash) prints a shell-completion script for the one-shot form.
  • zeq update re-runs the pinned installer against your origin.

The rest of this section​

Source: shared/pulse/src/cli/ (commands, help, tutorial) — served per-node at /cli/zeq.