CLI

The gridz command-line tool is for power users and developers who want to manage profiles from the terminal — without the gridz.bio web UI. Your private key stays local; Gridz never custodies it.

Install

# From the monorepo (developers)
pnpm --filter @gridz/cli build
pnpm exec gridz --help

# Or use via npx once published
npx @gridz/cli --help

Typical workflow

# 1. Scaffold a config (shape only — you fill in values)
gridz init --template minimal

# 2. Add cells
gridz cell add alias "Your Name"
gridz cell add description "A short bio"
gridz cell add url "https://gridz.bio"

# 3. Validate, build signed JSON, verify
gridz grid validate
gridz grid build -o grid.json
gridz grid verify grid.json

# 4. Publish to a sink (ENS, sqlite, etc.)
gridz sink list
gridz publish --sink ens --grid grid.json

For ENS publish you need an RPC URL and a wallet/signer in your environment — same as any on-chain write. gridz.bio's web UI handles this for *.gridz.eth users via browser signing + server registrar.

Commands

CommandDescription
gridz init -t <template>Create gridz.yaml from a template (minimal, etc.).
gridz grid validate [path]Check config shape and required fields.
gridz grid build [path] -o grid.jsonSign all cells and produce a Grid JSON file.
gridz grid verify <grid.json>Verify every attestation in a built Grid.
gridz cell add <key> <value>Append a cell to your gridz.yaml.
gridz identity whoamiShow the active signer derived from env / keystore.
gridz publish --sink <name>Push a signed Grid to a sink (ENS, sqlite, memory, …).
gridz sink listList available sink adapters.
gridz sink test <name>Probe connectivity for a sink.
gridz schema <key>Look up the schema for a cell key.

Add --json to any command for machine-readable output. See the examples/minimal-cli project for a complete script that publishes to SQLite and renders static HTML.