1 minute read.Last Modified 2023-11-15 12:16 EST
The TrueNAS CLI guide for SCALE is a work in progress! New namespace and command documentation is continually added and maintained, so check back here often to see what is new!
Welcome to the TrueNAS SCALE Command Line Interface (CLI) guide!
The TrueNAS CLI in TrueNAS SCALE functions like a text-based version of the web UI with many functional areas grouped into parent and child namespaces that mirror the counterparts in the SCALE UI.
The underlying structure of the CLI namespaces and commands closely follows that of the SCALE API. For more information on API commands, arguments, options, and definitions go to API Keys and click on API Docs in the SCALE UI.
The cloud_sync namespace has one child namespace and is based on functions found in the SCALE API and web UI. It provides access to cloud_sync task configuration methods through the child namespace and commands.
You can enter commands from the main CLI prompt or from the cloud_sync namespace prompts.
The following articles provide information on cloud_sync child authentication namespaces:
- Credential: Provides information about the task cloud_sync credential namespace in the TrueNAS CLI. Includes command syntax and common commands.