every
CLI for interacting with Every Protocol
Install
bun a -g @everyprotocol/every-cliUsage
CLI for interacting with Every Protocol
every --helpUsage: every [options] [command]
CLI for interacting with Every Protocol
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
universe manage universes
matter matter utilities
set manage sets
kind manage kinds
relation manage relations
value manage values
unique manage uniques
object manage objects
minter manage mint policies
balance manage balances
wallet manage wallets
config view merged configuration and source files
help [command] display help for commandevery universe
manage universes
every universe --helpUsage: every universe [options] [command]
manage universes
Options:
-h, --help display help for command
Commands:
start [options] <universe> <horizon> <herald> Start a universe
help [command] display help for commandevery universe start
Start a universe
every universe start --helpUsage: every universe start [options] <universe> <horizon> <herald>
Start a universe
Arguments:
universe Universe ID
horizon Block number
herald Herald address (SS58 or 0x hex)
Options:
-n, --network <network> Network name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery matter
matter utilities
every matter --helpUsage: every matter [options] [command]
matter utilities
Options:
-h, --help display help for command
Commands:
register [options] <files...> Register matters
compile [options] <files...> Compile matters from human-readable to binary
hash [options] <files...> Compute matter hashes
pick [options] <files...> Pick matter hashes from a hash output file
help [command] display help for commandevery matter register
Register matters
every matter register --helpUsage: every matter register [options] <files...>
Register matters
Arguments:
files Paths of matter blob files
Options:
-n, --network <network> Network name (default: "local")
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery matter compile
Compile matters from human-readable to binary
every matter compile --helpUsage: every matter compile [options] <files...>
Compile matters from human-readable to binary
Arguments:
files Paths to matter files
Options:
-o, --out <dir> Output directory
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery matter hash
Compute matter hashes
every matter hash --helpUsage: every matter hash [options] <files...>
Compute matter hashes
Arguments:
files Paths of matter blob files
Options:
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery matter pick
Pick matter hashes from a hash output file
every matter pick --helpUsage: every matter pick [options] <files...>
Pick matter hashes from a hash output file
Arguments:
files Paths of the matter files
Options:
--from <file> Path to the hash output file (default: "register/hashes.json")
-h, --help display help for commandevery set
manage sets
every set --helpUsage: every set [options] [command]
manage sets
Options:
-h, --help display help for command
Commands:
deploy [options] <artifact> [args...] Deploy a set contract
register [options] <contract> <data> Registers the calling contract as a new set in the SetRegistry.
update [options] <id> <data> Updates the content hash of the set represented by the calling contract.
upgrade [options] <id> Upgrade an existing set
touch [options] <id> Increments the revision of the calling contract’s set without changing content.
owner [options] <id> Returns the current owner of a set
descriptor [options] <id> Returns the descriptor at a given revision
snapshot [options] <id> Returns descriptor and elements of a set at a specific revision
help [command] display help for commandevery set deploy
Deploy a set contract
every set deploy --helpUsage: every set deploy [options] <artifact> [args...]
Deploy a set contract
Arguments:
artifact Artifact path of the contract
args Constructor arguments
Options:
-o, --out <dir> Artifact output directory (default: "./out")
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery set register
Registers the calling contract as a new set in the SetRegistry.
every set register --helpUsage: every set register [options] <contract> <data>
Registers the calling contract as a new set in the SetRegistry.
Arguments:
contract Contract address
data Content hash (e.g., metadata or schema reference).
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery set update
Updates the content hash of the set represented by the calling contract.
every set update --helpUsage: every set update [options] <id> <data>
Updates the content hash of the set represented by the calling contract.
Arguments:
id Set ID.
data New content hash.
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery set upgrade
Upgrade an existing set
every set upgrade --helpUsage: every set upgrade [options] <id>
Upgrade an existing set
Arguments:
id Set ID.
Options:
--krev <rev0> New kind revision (default: 0)
--srev <rev0> New set revision (default: 0)
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery set touch
Increments the revision of the calling contract’s set without changing content.
every set touch --helpUsage: every set touch [options] <id>
Increments the revision of the calling contract’s set without changing content.
Arguments:
id Set ID.
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery set owner
Returns the current owner of a set
every set owner --helpUsage: every set owner [options] <id>
Returns the current owner of a set
Arguments:
id Set ID
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery set descriptor
Returns the descriptor at a given revision
every set descriptor --helpUsage: every set descriptor [options] <id>
Returns the descriptor at a given revision
Arguments:
id Set ID
Options:
--rev <rev0> Revision to query (0 = latest) (default: 0)
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery set snapshot
Returns descriptor and elements of a set at a specific revision
every set snapshot --helpUsage: every set snapshot [options] <id>
Returns descriptor and elements of a set at a specific revision
Arguments:
id Set ID
Options:
--rev <rev0> Revision to query (0 = latest) (default: 0)
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery kind
manage kinds
every kind --helpUsage: every kind [options] [command]
manage kinds
Options:
-h, --help display help for command
Commands:
register [options] <code> <data> Register a new kind
update [options] <id> Update an existing kind
upgrade [options] <id> Upgrades kind/set revision of an existing
kind
touch [options] <id> Touches a kind (bumps revision with no
content changes)
transfer [options] <id> <to> Transfers ownership of a kind
owner [options] <id> Returns the current owner of a kind
descriptor [options] <id> Returns the descriptor at a given revision
snapshot [options] <id> Returns descriptor and elements at a
specific revision
help [command] display help for commandevery kind register
Register a new kind
every kind register --helpUsage: every kind register [options] <code> <data>
Register a new kind
Arguments:
code Matter hash of the kind code
data Matter hash of the kind data
Options:
--elements <ety...> Element types
--relations <rel...> IDs of relations supported
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery kind update
Update an existing kind
every kind update --helpUsage: every kind update [options] <id>
Update an existing kind
Arguments:
id Kind id
Options:
--code <code> Matter hash of the kind code
--data <data> Matter hash of the kind data
--relations [rel...] IDs of relations supported
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery kind upgrade
Upgrades kind/set revision of an existing kind
every kind upgrade --helpUsage: every kind upgrade [options] <id>
Upgrades kind/set revision of an existing kind
Arguments:
id Kind ID
Options:
--krev <rev0> New kind revision (0 = skip) (default: 0)
--srev <rev0> New set revision (0 = skip) (default: 0)
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery kind touch
Touches a kind (bumps revision with no content changes)
every kind touch --helpUsage: every kind touch [options] <id>
Touches a kind (bumps revision with no content changes)
Arguments:
id Kind ID
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery kind transfer
Transfers ownership of a kind
every kind transfer --helpUsage: every kind transfer [options] <id> <to>
Transfers ownership of a kind
Arguments:
id Kind ID
to New owner address
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery kind owner
Returns the current owner of a kind
every kind owner --helpUsage: every kind owner [options] <id>
Returns the current owner of a kind
Arguments:
id Kind ID
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery kind descriptor
Returns the descriptor at a given revision
every kind descriptor --helpUsage: every kind descriptor [options] <id>
Returns the descriptor at a given revision
Arguments:
id Kind ID
Options:
--rev <rev0> Revision to query (0 = latest) (default: 0)
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery kind snapshot
Returns descriptor and elements at a specific revision
every kind snapshot --helpUsage: every kind snapshot [options] <id>
Returns descriptor and elements at a specific revision
Arguments:
id Kind ID
Options:
--rev <rev0> Revision to query (0 = latest) (default: 0)
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery relation
manage relations
every relation --helpUsage: every relation [options] [command]
manage relations
Options:
-h, --help display help for command
Commands:
register [options] <data> <rule> <adjs...> Register a new relation
update [options] <rel> <data> Update an existing relation
upgrade [options] <id> <kindRev> <setRev> Upgrades the kind or set revision of a relation
touch [options] <id> Touches a relation (bumps revision without modifying content)
transfer [options] <id> <to> Transfers ownership of a relation to a new address
owner [options] <id> Gets the current owner of a relation
descriptor [options] <id> <rev0> Returns descriptor of a relation at a specific revision
snapshot [options] <id> <rev0> Returns descriptor and packed elements at a specific revision
rule [options] <id> Returns the rule definition for a relation
admit [options] <id> <rev> <kind> Checks if a relation admits a specific kind as tail
help [command] display help for commandevery relation register
Register a new relation
every relation register --helpUsage: every relation register [options] <data> <rule> <adjs...>
Register a new relation
Arguments:
data Matter hash of the relation data
rule Relation rule
adjs Relation adjacencies
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery relation update
Update an existing relation
every relation update --helpUsage: every relation update [options] <rel> <data>
Update an existing relation
Arguments:
rel Relation ID
data Matter hash of the relation data
Options:
--adjs <adjacency...> Relation adjacencies
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery relation upgrade
Upgrades the kind or set revision of a relation
every relation upgrade --helpUsage: every relation upgrade [options] <id> <kindRev> <setRev>
Upgrades the kind or set revision of a relation
Arguments:
id Relation ID
kindRev New kind revision (0 = no change)
setRev New set revision (0 = no change)
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery relation touch
Touches a relation (bumps revision without modifying content)
every relation touch --helpUsage: every relation touch [options] <id>
Touches a relation (bumps revision without modifying content)
Arguments:
id Relation ID
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery relation transfer
Transfers ownership of a relation to a new address
every relation transfer --helpUsage: every relation transfer [options] <id> <to>
Transfers ownership of a relation to a new address
Arguments:
id Relation ID
to New owner address
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery relation owner
Gets the current owner of a relation
every relation owner --helpUsage: every relation owner [options] <id>
Gets the current owner of a relation
Arguments:
id Relation ID
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery relation descriptor
Returns descriptor of a relation at a specific revision
every relation descriptor --helpUsage: every relation descriptor [options] <id> <rev0>
Returns descriptor of a relation at a specific revision
Arguments:
id Relation ID
rev0 Revision to query (0 = latest)
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery relation snapshot
Returns descriptor and packed elements at a specific revision
every relation snapshot --helpUsage: every relation snapshot [options] <id> <rev0>
Returns descriptor and packed elements at a specific revision
Arguments:
id Relation ID
rev0 Revision to query (0 = latest)
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery relation rule
Returns the rule definition for a relation
every relation rule --helpUsage: every relation rule [options] <id>
Returns the rule definition for a relation
Arguments:
id Relation ID
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery relation admit
Checks if a relation admits a specific kind as tail
every relation admit --helpUsage: every relation admit [options] <id> <rev> <kind>
Checks if a relation admits a specific kind as tail
Arguments:
id Relation ID
rev Revision to check
kind Tail kind ID to evaluate
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery value
manage values
every value --helpUsage: every value [options] [command]
manage values
Options:
-h, --help display help for command
Commands:
register [options] <code> <data> <std> <decimals> <symbol> Registers a new value token
upgrade [options] <id> <kindRev0> <setRev0> Upgrades the kind/set revision of a value
touch [options] <id> Touches a value, bumping its revision without changing its content
transfer [options] <id> <to> Transfers ownership of a value to a new address
owner [options] <id> Returns the current owner of a value
descriptor [options] <id> <rev0> Returns the descriptor of a value at a specific revision
snapshot [options] <id> <rev0> Returns descriptor and elements of a value at a specific revision
help [command] display help for commandevery value register
Registers a new value token
every value register --helpUsage: every value register [options] <code> <data> <std> <decimals> <symbol>
Registers a new value token
Arguments:
code Token contract address
data Hash of the underlying matter or metadata
std Token standard (e.g. ERC20)
decimals Token's decimal precision
symbol Display symbol (max 30 characters)
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery value upgrade
Upgrades the kind/set revision of a value
every value upgrade --helpUsage: every value upgrade [options] <id> <kindRev0> <setRev0>
Upgrades the kind/set revision of a value
Arguments:
id Value ID
kindRev0 New kind revision (0 = no change)
setRev0 New set revision (0 = no change)
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery value touch
Touches a value, bumping its revision without changing its content
every value touch --helpUsage: every value touch [options] <id>
Touches a value, bumping its revision without changing its content
Arguments:
id Value ID
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery value transfer
Transfers ownership of a value to a new address
every value transfer --helpUsage: every value transfer [options] <id> <to>
Transfers ownership of a value to a new address
Arguments:
id Value ID
to Address to transfer ownership to
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery value owner
Returns the current owner of a value
every value owner --helpUsage: every value owner [options] <id>
Returns the current owner of a value
Arguments:
id Value ID
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery value descriptor
Returns the descriptor of a value at a specific revision
every value descriptor --helpUsage: every value descriptor [options] <id> <rev0>
Returns the descriptor of a value at a specific revision
Arguments:
id Value ID
rev0 Revision to query (0 = latest)
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery value snapshot
Returns descriptor and elements of a value at a specific revision
every value snapshot --helpUsage: every value snapshot [options] <id> <rev0>
Returns descriptor and elements of a value at a specific revision
Arguments:
id Value ID
rev0 Revision to query (0 = latest)
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery unique
manage uniques
every unique --helpUsage: every unique [options] [command]
manage uniques
Options:
-h, --help display help for command
Commands:
register [options] <code> <data> <std> <decimals> <symbol> Registers a new unique token
upgrade [options] <id> <kindRev> <setRev> Upgrades the kind and/or set revision of a unique
touch [options] <id> Bumps the revision of a unique with no content change
transfer [options] <id> <to> Transfers ownership of a unique token
owner [options] <id> Returns the current owner of a unique
descriptor [options] <id> <rev0> Returns the descriptor at a given revision
snapshot [options] <id> <rev0> Returns descriptor and elements at a specific revision
help [command] display help for commandevery unique register
Registers a new unique token
every unique register --helpUsage: every unique register [options] <code> <data> <std> <decimals> <symbol>
Registers a new unique token
Arguments:
code Address of the token contract
data Hash of the associated matter
std Token standard (e.g. ERC721)
decimals Number of decimals
symbol Display symbol (max 30 characters)
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery unique upgrade
Upgrades the kind and/or set revision of a unique
every unique upgrade --helpUsage: every unique upgrade [options] <id> <kindRev> <setRev>
Upgrades the kind and/or set revision of a unique
Arguments:
id Unique ID
kindRev New kind revision (0 = no change)
setRev New set revision (0 = no change)
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery unique touch
Bumps the revision of a unique with no content change
every unique touch --helpUsage: every unique touch [options] <id>
Bumps the revision of a unique with no content change
Arguments:
id Unique ID
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery unique transfer
Transfers ownership of a unique token
every unique transfer --helpUsage: every unique transfer [options] <id> <to>
Transfers ownership of a unique token
Arguments:
id Unique ID
to Address of the new owner
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery unique owner
Returns the current owner of a unique
every unique owner --helpUsage: every unique owner [options] <id>
Returns the current owner of a unique
Arguments:
id Unique ID
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery unique descriptor
Returns the descriptor at a given revision
every unique descriptor --helpUsage: every unique descriptor [options] <id> <rev0>
Returns the descriptor at a given revision
Arguments:
id Unique ID
rev0 Revision to query (0 = latest)
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery unique snapshot
Returns descriptor and elements at a specific revision
every unique snapshot --helpUsage: every unique snapshot [options] <id> <rev0>
Returns descriptor and elements at a specific revision
Arguments:
id Unique ID
rev0 Revision to query (0 = latest)
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object
manage objects
every object --helpUsage: every object [options] [command]
manage objects
Options:
-h, --help display help for command
Commands:
mint [options] <sid0> Mint an object
upgrade [options] <sid> Upgrade an object
touch [options] <sid> Touch an object
transfer [options] <sid> <to> Transfer an object
send [options] <sig> [args...] Send a transaction to set contract
relate [options] <tail> <rel> <head> Link a tail object to a head object
unrelate [options] <tail> <rel> <head> Unlink a tail object from a head object
owner [options] <sid> Get object owner
descriptor [options] <sid> Get object descriptor
snapshot [options] <sid> Get object snapshot
uri [options] <sid> Get object URI
help [command] display help for commandevery object mint
Mint an object
every object mint --helpUsage: every object mint [options] <sid0>
Mint an object
Arguments:
sid0 Object SID, in form of {set}.{id0}
Options:
--to <address> Recipient address
--data <data> Extra mint data
--value <amount> Send an amount of ETH
--minter Via ObjectMinter instead
--policy <index> Index of the mint policy to search afterward
--auth <data> Authorization data for permission
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object upgrade
Upgrade an object
every object upgrade --helpUsage: every object upgrade [options] <sid>
Upgrade an object
Arguments:
sid Object SID, in form of {set}.{id}
Options:
--krev <rev> Upgrade kind to specified revison
--srev <rev> Upgrade set to specified revison
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object touch
Touch an object
every object touch --helpUsage: every object touch [options] <sid>
Touch an object
Arguments:
sid Object SID, in form of {set}.{id}
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object transfer
Transfer an object
every object transfer --helpUsage: every object transfer [options] <sid> <to>
Transfer an object
Arguments:
sid Object SID, in form of {set}.{id}
to Recipient address
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object send
Send a transaction to set contract
every object send --helpUsage: every object send [options] <sig> [args...]
Send a transaction to set contract
Arguments:
sig Signature, e.g. 'transfer(address,uint256)'
args Arguments
Options:
--value <amount> the amount of ETH to send
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object relate
Link a tail object to a head object
every object relate --helpUsage: every object relate [options] <tail> <rel> <head>
Link a tail object to a head object
Arguments:
tail Tail object, in form of [[data.]grant.]set.id
rel Relation ID
head Head object, in form of [grant.]set.id
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object unrelate
Unlink a tail object from a head object
every object unrelate --helpUsage: every object unrelate [options] <tail> <rel> <head>
Unlink a tail object from a head object
Arguments:
tail Tail object, in form of [[data.]grant.]set.id
rel Relation ID
head Head object, in form of [grant.]set.id
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object owner
Get object owner
every object owner --helpUsage: every object owner [options] <sid>
Get object owner
Arguments:
sid Object SID, in form of {set}.{id}
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object descriptor
Get object descriptor
every object descriptor --helpUsage: every object descriptor [options] <sid>
Get object descriptor
Arguments:
sid Object SID, in form of {set}.{id}
Options:
--rev <rev> At the specified revision
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object snapshot
Get object snapshot
every object snapshot --helpUsage: every object snapshot [options] <sid>
Get object snapshot
Arguments:
sid Object SID, in form of {set}.{id}
Options:
--rev <rev> At the specified revision
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery object uri
Get object URI
every object uri --helpUsage: every object uri [options] <sid>
Get object URI
Arguments:
sid Object SID, in form of {set}.{id}
Options:
--rev <rev> At the specified revision
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery minter
manage mint policies
every minter --helpUsage: every minter [options] [command]
manage mint policies
Options:
-h, --help display help for command
Commands:
add [options] <contract> <policy> Adds a new mint policy for the set represented by the calling contract
enable [options] <contract> <index> Enables a mint policy for the set represented by the calling contract
disable [options] <contract> <index> Disables a mint policy for the set represented by the calling contract
count [options] <set> Get number of mint policies for a set
get [options] <set> <index> Get mint policy by index
search [options] <set> <id> <mask> <offset> Search for applicable mint policy with offset and permission mask
help [command] display help for commandevery minter add
Adds a new mint policy for the set represented by the calling contract
every minter add --helpUsage: every minter add [options] <contract> <policy>
Adds a new mint policy for the set represented by the calling contract
Arguments:
contract address of the set contract
policy The policy configuration to add
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery minter enable
Enables a mint policy for the set represented by the calling contract
every minter enable --helpUsage: every minter enable [options] <contract> <index>
Enables a mint policy for the set represented by the calling contract
Arguments:
contract address of the set contract
index Index of the policy to enable
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery minter disable
Disables a mint policy for the set represented by the calling contract
every minter disable --helpUsage: every minter disable [options] <contract> <index>
Disables a mint policy for the set represented by the calling contract
Arguments:
contract address of the set contract
index Index of the policy to disable
Options:
-u, --universe <universe> Universe name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery minter count
Get number of mint policies for a set
every minter count --helpUsage: every minter count [options] <set>
Get number of mint policies for a set
Arguments:
set The set address to query
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery minter get
Get mint policy by index
every minter get --helpUsage: every minter get [options] <set> <index>
Get mint policy by index
Arguments:
set The set address
index Policy index
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery minter search
Search for applicable mint policy with offset and permission mask
every minter search --helpUsage: every minter search [options] <set> <id> <mask> <offset>
Search for applicable mint policy with offset and permission mask
Arguments:
set The set address
id The object ID to check
mask Bitmask indicating which MintPermissionType values
are included. Each bit corresponds to a
permission type (e.g., bit 0 = Public, bit 1 =
Allowlist, etc.).
offset Starting policy index to search from
Options:
-u, --universe <universe> Universe name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery balance
manage balances
every balance --helpUsage: every balance [options] [command]
manage balances
Options:
-h, --help display help for command
Commands:
query [options] <address> Query account balance
transfer [options] <address> <amount> Transfer balance to account
help [command] display help for commandevery balance query
Query account balance
every balance query --helpUsage: every balance query [options] <address>
Query account balance
Arguments:
address Account address (SS58 or 0x hex)
Options:
-n, --network <network> Network name (default: "local")
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery balance transfer
Transfer balance to account
every balance transfer --helpUsage: every balance transfer [options] <address> <amount>
Transfer balance to account
Arguments:
address Recipient account address (SS58 or 0x hex)
amount Amount in base units
Options:
-n, --network <network> Network name (default: "local")
-a, --account <account> Name of the keystore
-p, --password [password] Password to decrypt the keystore
-P, --password-file <file> File containing the keystore password
-f, --foundry Use foundry keystores (~/.foundry/keystores)
-j, --json [file] Output result as JSON to stdout or file
-q, --quiet Suppress info messages
-h, --help display help for commandevery wallet
manage wallets
every wallet --helpUsage: every wallet [options] [command]
manage wallets
Options:
-h, --help display help for command
Commands:
list [options] List all wallets
new [options] <name> Generate a new wallet
import [options] <name> <suri> Import a wallet from a secrete URI
inspect [options] <name> Inspect a wallet
help [command] display help for commandevery wallet list
List all wallets
every wallet list --helpUsage: every wallet list [options]
List all wallets
Options:
-f, --foundry use foundry keystore directory (~/.foundry/keystores)
--dir <dir> specify a custom keystore directory
-h, --help display help for commandevery wallet new
Generate a new wallet
every wallet new --helpUsage: every wallet new [options] <name>
Generate a new wallet
Arguments:
name name of the wallet
Options:
-t, --type <type> key type (sr25519, ed25519, ethereum) (default:
"sr25519")
-p, --password <password> password to encrypt the keystore
-P, --password-file <file> password file
--dir <dir> specify keystore directory
-h, --help display help for commandevery wallet import
Import a wallet from a secrete URI
every wallet import --helpUsage: every wallet import [options] <name> <suri>
Import a wallet from a secrete URI
Arguments:
name name of the wallet
suri secret URI
Options:
-t, --type <type> key type (sr25519, ed25519, ethereum) (default:
"sr25519")
-p, --password <password> password to encrypt the keystore
-P, --password-file <file> password file
--dir <dir> specify a custom keystore directory
-f, --foundry use foundry keystore directory
(~/.foundry/keystores)
-h, --help display help for commandevery wallet inspect
Inspect a wallet
every wallet inspect --helpUsage: every wallet inspect [options] <name>
Inspect a wallet
Arguments:
name name of the wallet
Options:
-t, --type <type> key type (sr25519, ed25519, ethereum) (default:
"sr25519")
-p, --password <password> password to decrypt the keystore
-P, --password-file <file> file containing the password
-x, --decrypt also decrypt the private key (default: false)
--dir <dir> specify a custom keystore directory
-f, --foundry use foundry keystore directory
(~/.foundry/keystores)
-h, --help display help for commandevery config
view merged configuration and source files
every config --helpUsage: every config [options] [command]
view merged configuration and source files
Options:
-h, --help display help for command
Commands:
show [options] show mreged configuration
files list configuration files searched
help [command] display help for commandevery config show
show mreged configuration
every config show --helpUsage: every config show [options]
show mreged configuration
Options:
-u, --universe <universe> Show config of this universe only
-n, --network <network> Show config of this network only
-h, --help display help for commandevery config files
list configuration files searched
every config files --helpUsage: every config files [options]
list configuration files searched
Options:
-h, --help display help for commandevery pick
Pick values from outputs
every pick --helpUsage: every pick [options] <keys...>
Pick values from outputs
Arguments:
keys Keys to resolve
Options:
--from <dir> Output directory (default: "./register")
-u, --universe <name> Universe name (default: "local")
-h, --help display help for command