TrueNAS CORE
TrueNAS Enterprise
TrueNAS SCALE
Compare Editions
TrueCommand
Software Status
FreeNAS
Compare Systems
F-Series
M-Series
X-Series
R-Series
Mini Series
Download TrueNAS CORE
Download TrueNAS SCALE
Get TrueNAS Enterprise
Where to BuyTrueNAS SCALE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.
Sharing
2 minute read.
Last Modified 2024-03-15 13:07 EDTThe 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 sharing namespace has three child namespaces and is based on functions found in the SCALE API and web UI. It provides access to configure shares through the child namespaces and their commands.
You can enter commands from the main CLI prompt or from the sharing namespace prompts.
The following articles provide information on sharing child namespaces:
- iSCSI: Provides information about the sharing iscsi namespace in the TrueNAS CLI. Includes command syntax and common commands.
- NFS: Provides information about the sharing nfs namespace in the TrueNAS CLI. Includes command syntax and common commands.
- SMB: Provides information about the sharing smb namespace in the TrueNAS CLI. Includes command syntax and common commands.