CLI Reference¶
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. |
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. |
Stake¶
Manage stakes and other staker-related operations.
(nucypher)$ nucypher stake ACTION [OPTIONS]
Stake Command Actions
Action |
Description |
---|---|
|
Create a new stakeholder configuration |
|
Initialize NuCypher stakes (used with |
|
Increase an existing stake’s value |
|
List active stakes for current stakeholder |
|
Show ETH and NU balances for stakeholder’s accounts |
|
Bond a worker to a staker |
|
Unbond worker currently bonded to a staker |
|
Withdraw staking compensation from the contract to your wallet |
|
Create a new stake from part of an existing one |
|
Manage automatic reward re-staking |
|
Prolong an existing stake’s duration |
|
Manage winding down of stakes |
|
Manage taking snapshots |
|
Mint last portion of reward |
|
Merge two stakes into one |
|
Remove unused stake |
|
View StakingEscrow blockchain events associated with a staker |
Stake Command Options
Option |
Description |
---|---|
|
Stake value (optional) |
|
Stake duration of extension (optional) |
|
Stake index (optional) |
Re-stake Command Options
Option |
Description |
---|---|
|
Enable re-staking |
|
Disable re-staking |
|
Enable re-staking lock until release period |
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 Bob. |
|
View and optionally update an existing Ursula’s configuration. |
|
Delete existing Bob’s configuration. |
|
Delete all stored peer metadata. |
|
Manually write node metadata to disk without running. |
|
Start Ursula. |
Cloudworkers¶
Manage worker and other staker-related operations on cloud infrastructure.
(nucypher)$ nucypher cloudworkers ACTION [OPTIONS]
Cloudworkers Command Actions
Action |
Description |
---|---|
|
Creates and deploys hosts for all active local stakers. |
|
Creates and deploys the given number of hosts independent of stakes |
|
Add an existing host to be managed by cloudworkers CLI tools |
|
Add an existing host to be managed for a specified local staker address |
|
Install and run Ursula on existing managed hosts. |
|
Update or manage existing installed Ursula. |
|
Shut down and cleanup resources deployed on AWS or Digital Ocean |
|
Stop the selected nodes. |
|
Prints a formatted status of selected managed hosts. |
|
Download and display the accumulated stdout logs of selected hosts |
|
Download local copies of critical data from selected installed Ursulas |
|
Reconstitute and deploy an operating Ursula from backed up data |
|
Print local nicknames of all managed hosts under a given namespace |
|
Print namespaces under a given network |
Status¶
Echo a snapshot of live NuCypher Network metadata.
(nucypher)$ nucypher status ACTION [OPTIONS]
Status Command Actions
Action |
Description |
---|---|
|
Show events associated to NuCypher contracts. |
|
Provide information on the global fee range. |
|
Display a graph of the number of locked tokens over time. |
|
Overall information of the NuCypher Network. |
|
Show relevant information about stakers. |