Each How-To is a short reference that shows how to use a feature or achieve an outcome.

For each How-To you visit, you should do the following:

  • Read the explained procedure.

  • Try the steps on your own.

  • Compare to the “Example Output”.

  • Refer to the “What Can Go Wrong” guidance.

  • If you need more explanation, click the link to see a video. (Coming Soon)

How to Interpret the Variables in the CLI How-To Topics

  • Variables will have a relatively explanatory name and be enclosed by angle brackets, < >.

  • Simple examples:

  • <ip_address>: whatever the relevant IP address should be in the given context.

  • <ssh_key>: the SSH key held locally.

  • <ssh_username>: the username associated with the SSH key.

Some variables will express a path on a system, either local or remote. Sometimes the basic path is known except for a few parts, and other times there is really no way to know what it is up front.

  • /home/<local_user_name>/.ssh/<ssh_key>: when the basic path is known, i.e. /home/ and /.ssh/ but your local username and the private key file aren’t.

  • ~/.ssh/<ssh_key>: an alternate to the example above that uses a relative path.

  • C:\Users\<windows_username>\AppData\Local\NVIDIA Corporation\AI Workbench\: another example where you just have to fill in a username.

  • <absolute/local/path/to/file_name>: when the path is completely unknown and you have to substitute the entire thing but the path is required to be absolute. This means you can’t use something like ~/ as a substitute for /home/<user_name>.

Previous Quickstart in the Desktop Application
Next Command-line Interface (CLI) Basics
© Copyright 2023-2024, NVIDIA. Last updated on Jan 21, 2024.