CLI Reference¶
Ursula¶
“Ursula the Untrusted” PRE Re-encryption node management commands.
(nucypher)$ nucypher ursula ACTION [OPTIONS]
Ursula Command Actions
Action |
Description |
---|---|
|
Create a brand new persistent Ursula. |
|
View and optionally update an existing Ursula’s configuration. |
|
Delete existing Ursula’s configuration. |
|
Delete all stored peer metadata. |
|
Manually write node metadata to disk without running. |
|
Start Ursula. |
Bond¶
Bond an Operator to a Staking Provider. The Staking Provider must be authorized to use the PREApplication.
(nucypher)$ nucypher bond [OPTIONS]
Unbond¶
Unbonds an operator from an authorized Staking Provider.
(nucypher)$ nucypher unbond [OPTIONS]
Enrico¶
“Enrico the Encryptor” management commands.
(nucypher)$ nucypher enrico ACTION [OPTIONS]
Enrico Command Actions
Action |
Description |
---|---|
|
Encrypt a message under a given policy public key. |
|
Start Enrico’s HTTP controller. |
Status¶
Echo a snapshot of live PRE Application metadata.
(nucypher)$ nucypher status ACTION [OPTIONS]
Status Command Actions
Action |
Description |
---|---|
|
Show events associated to PRE Application contracts. |
Alice¶
“Alice the Policy Authority” management commands.
(nucypher)$ nucypher alice ACTION [OPTIONS]
Alice Command Actions
Action |
Description |
---|---|
|
Create a brand new persistent Alice. |
|
View and optionally update an existing Alice’s configuration. |
|
Delete existing Alice’s configuration. |
|
Decrypt data encrypted using an Alice’s policy encrypting key |
|
Derive a policy public key from a policy label. |
|
Create and enact an access policy for some Bob. |
|
Create a character card file for public key sharing. |
|
Obtain Alice’s public verification and encryption. |
|
Revoke a policy. |
|
Start Alice’s HTTP controller. |
Bob¶
“Bob the Data Recipient” management commands.
(nucypher)$ nucypher bob ACTION [OPTIONS]
Bob Command Actions
Action |
Description |
---|---|
|
Create a brand new persistent Bob. |
|
View and optionally update an existing Bob’s configuration. |
|
Delete existing Bob’s configuration. |
|
Obtain plaintext from encrypted data, if access was granted. |
|
Create a character card file for public key sharing. |
|
Obtain Bob’s public verification and encryption. |
|
Start Bob’s HTTP controller. |