operators-guide: incorporated PR #3656

2023-07-26 12:55:05 +02:00
parent f2a395fe42
commit c120196be0
4 changed files with 19 additions and 0 deletions
@@ -45,6 +45,7 @@ You can also check the various arguments required for individual commands with:
 ```
 ./nym-gateway <COMMAND> --help
 ```
+> Adding `--no-banner` startup flag will prevent Nym banner being printed even if run in tty environment.

 ### Initialising your gateway
 To check available configuration options use:
@@ -4,6 +4,20 @@
 TODO
 - [x] Compare mixnode, gateway, NR steps and validator of upgrading and automation and make a generic page - this one - for all of them with additional notes for particular nodes
 --->
+## Useful commands
+
+> Adding `--no-banner` startup flag will prevent Nym banner being printed even if run in tty environment.
+
+**build-info**
+
+A `build-info` command prints the build information like commit hash, rust version, binary version just like what command `--version` does. However, you can also specify an `--output=json` flag that will format the whole output as a json, making it an order of magnitude easier to parse.
+
+For example `./target/debug/nym-network-requester --no-banner build-info --output json` will return:
+
+```
+{"binary_name":"nym-network-requester","build_timestamp":"2023-07-24T15:38:37.00657Z","build_version":"1.1.23","commit_sha":"c70149400206dce24cf20babb1e64f22202672dd","commit_timestamp":"2023-07-24T14:45:45Z","commit_branch":"feature/simplify-cli-parsing","rustc_version":"1.71.0","rustc_channel":"stable","cargo_profile":"debug"}
+```
+
 ## Upgrading your node

 > The process is the similar for mixnode, gateway and network requester. In the following steps we use a placeholder `<NODE>` in the commands, please change it for the type of node you want to upgrade. Any particularities for the given type of node are included.
@@ -67,6 +67,8 @@ You can also check the various arguments required for individual commands with:
 ./nym-mixnode <COMMAND> --help
 ```

+> Adding `--no-banner` startup flag will prevent Nym banner being printed even if run in tty environment.
+
 ### Initialising your mix node

 To check available configuration options for initializing your node use:
@@ -107,6 +107,8 @@ You can check the required parameters for available commands by running:
 ./nym-network-requester <COMMAND> --help
 ```

+> Adding `--no-banner` startup flag will prevent Nym banner being printed even if run in tty environment.
+
 ## Initializing and running your network requester

 The network-requester needs to be initialized before it can be run. This is required for the embedded nym-client to connect successfully to the mixnet. We want to specify an `<ID>` using the `--id` command and give it a value of your choice. The following command will achieve that: