Quickstart

Get the dregg CLI installed, connect to a running node, and perform your first operations. This takes under five minutes.

Install

Build and install from source (requires Rust 1.94+):

cargo install --path cli

This gives you the dregg command. Verify it works:

dregg --version

Connect to a Node

Initialize your local config and point it at a running node:

# Create ~/.dregg/config.toml with defaults
dregg config init

# Check the node is reachable
dregg node status

By default the CLI connects to http://127.0.0.1:8420. If your node is elsewhere, edit ~/.dregg/config.toml or pass --node-url.

First Operations

Check your computron balance and export a capability:

# Show balances for cells you own
dregg cclerk balance

# Export a capability as a portable sturdy ref
dregg cap export <cell-id>

The exported capability is a dregg:// URI containing a swiss number. Anyone who receives it can enliven the reference to get a live handle to that cell.

Key Concepts

Cells

A cell is the unit of state. Each cell has a 32-byte identity, a set of typed fields, a c-list (capability list) of references it holds, and a commitment hash. Cells can be sovereign (you execute locally, prove with a STARK) or hosted (the federation executes on your behalf). In sovereign mode the federation only ever sees the 32-byte commitment -- never your data.

Turns

A turn is an atomic state transition. You build a call forest targeting one or more cells, execute it locally, then submit (turn_hash, new_commitment, proof) to the federation. The Effect VM supports 24 effects: transfers, capability grants/revocations, cell creation, seal/unseal, pipelined sends, bridge operations, and more. Each turn produces a STARK proof that the transition is valid.

Capabilities and Strands

Capabilities are unforgeable object references. They flow between cells via CapTP sessions organized into strands (logical communication channels). Sturdy references survive disconnection. The handoff protocol enables offline three-party introduction. Distributed GC reclaims unreachable capabilities automatically.

Next Steps