-
-
Notifications
You must be signed in to change notification settings - Fork 563
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(rust): Update CLI documentation for the
status
and reset
com…
…mands Signed-off-by: Wryhder <[email protected]>
- Loading branch information
Showing
3 changed files
with
12 additions
and
16 deletions.
There are no files selected for viewing
6 changes: 2 additions & 4 deletions
6
implementations/rust/ockam/ockam_command/src/reset/static/after_long_help.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,6 @@ | ||
# Removes the local Ockam configuration including all Spaces, Identities, and Nodes | ||
# This will prompt you for confirmation before proceeding | ||
$ ockam reset | ||
|
||
# To confirm without prompting | ||
$ ockam reset -y | ||
|
||
# Remove your spaces from the Orchestrator | ||
ockam reset --all | ||
$ ockam reset -y |
7 changes: 3 additions & 4 deletions
7
implementations/rust/ockam/ockam_command/src/status/static/after_long_help.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
# To show information about all of the system's Identities and Nodes | ||
# Includes all identities, whether enrolled or unenrolled | ||
# Display information about all of the system's Spaces, Identities, and Nodes | ||
$ ockam status | ||
|
||
# Change the default timeout duration of the status command | ||
# Defaults to 2s if unspecified | ||
$ ockam status --timeout 0.5s | ||
# Defaults to 10s if unspecified | ||
$ ockam status --timeout 15s |
15 changes: 7 additions & 8 deletions
15
implementations/rust/ockam/ockam_command/src/status/static/long_about.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,8 @@ | ||
[TBD: Is the following useful information?] | ||
[TBD: What needs to be elaborated on, and in what way?] | ||
|
||
The status command displays the current status of your machine, including information such as: | ||
- controller and project version [TBD: what are these?] | ||
- all cryptographic identities stored in your vault, their enrollment status with the Ockam Orchestrator, | ||
date of enrollment (if enrolled), and the email address associated with each identity | ||
- the status of any Nodes, process ids, associated routes and transport protocols, secure channels, | ||
portals, and running services | ||
- the current version of Ockam in use | ||
- the controller (Orchestrator) and project version | ||
- your spaces and the users associated with them | ||
- all cryptographic identities stored in your vault and their enrollment status with the Ockam Orchestrator | ||
- the status of any Nodes, associated routes and protocols, listeners and services, and more | ||
|
||
NB: To see the list of workers running in a node, run `ockam worker list --at <NAME_OF_NODE>` |