nillion

The nillion tool is a command line version of the Nillion Client. We refer to the tool as the CLI Client.

The nillion tool can be used to generate user keys, generate node keys, store secrets, retrieve a secret, store a program, compute on a program, get cluster information, check the preprocessing pool status, and display node and user ids from keys.

nillion can be run against the Nillion Network or against a local cluster spun up with nillion-devnet. If nillion is running against your local cluster, use the cluster id, bootnodes, smart contract addresses, chain id, rpc url endpoint values that are local cluster outputs as nillion options.

Installation

Follow instructions to install the Nillion SDK and Tools, which include nillion tool installation

Usage

Note: Starting with version v0.8.0 output is serialized into YAML by default (can also be set to JSON). Any integrations relying on output parsing will have to be updated.

Usage: nillion [OPTIONS] <COMMAND>

Commands:
  store-values               Store or update values in the network
  retrieve-values            Retrieve values from the network
  store-program              Store a program in the network
  compute                    Perform a computation in the network
  cluster-information        Fetch the cluster information
  delete-values              Delete values from the network
  preprocessing-pool-status  Fetch the preprocessing pool status for a cluster
  inspect-ids                Display the node/user ids derived from the provided keys
  shell-completions          Generate shell completions
  retrieve-permissions       Retrieve permissions for stored secrets
  overwrite-permissions      Overwrite all permissions on a stored secrets
  update-permissions         Update certain permissions on a stored secrets
  identity-gen               Generate user identities
  networks                   Manage network configurations
  identities                 Manage identities
  context                    Manage the context to use for all upcoming command invocations
  help                       Print this message or the help of the given subcommand(s)

Options:
  -i, --identity <IDENTITY>
          Identities configuration

  -n, --network <NETWORK>
          Network configuration name

      --output-format <OUTPUT_FORMAT>
          Output format
          
          [default: yaml]

          Possible values:
          - yaml: Serialise into YAML
          - json: Serialise into JSON

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

For any of the commands listed above, you can run nillion <COMMAND> --help and get detailed information on usage.