Sigil documentation

Inspect Sigil from your terminal.

The source workspace includes sigil-cli. Use explicit endpoints and chain IDs, and begin with read-only node and query commands.

Run from a Sigil source checkout

With a Rust toolchain and the workspace dependencies installed, run the CLI from the Sigil repository root. This builds the local CLI; it does not install an unverified remote binary.

cargo run --manifest-path node/Cargo.toml -p sigil-cli --bin sigil-cli -- --help

Read node identity

The node info command calls sigil_getNodeInfo. Pass --rpc-url explicitly because the CLI default targets localhost.

cargo run --manifest-path node/Cargo.toml -p sigil-cli --bin sigil-cli -- \
  --rpc-url 'https://rpc.sigil.ml/rpc' \
  --chain-id 'sigil-mainnet-1' node info

Read-only commands

Use the same global endpoint and chain-ID flags with these subcommands. Replace DID and hash placeholders with records from the selected network.

ItemDetails
node infoNode version and chain identity.
node peersNode peer information.
statusSynchronization status.
query blockLatest block window.
query block --height 1A block at an explicit height.
query balance <DID>Balance and nonce for an account.
query tx <HASH>A transaction by hash.

Before transaction commands

A command appearing in --help is not a guarantee that the selected network enables its transaction path. Check the matching specification, network policy, signer, nonce, and fee first. Keep private signing material out of command history and logs.

On this page