TrueNAS SCALE Version DocumentationThis content follows the TrueNAS SCALE 23.10 (Cobia) releases. Use the Product and Version selectors above to view content specific to different TrueNAS software or major version.
App
2 minute read.
Last Modified 2024-03-19 08:38 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 app namespace has five child namespaces and is based on functions found in the SCALE API and web UI. It provides access to application configuration methods through the child namespaces and their commands.
You can enter commands from the main CLI prompt or from the app namespace prompts.
The following articles provide information on app child namespaces:
- Catalog: Provides information about the app catalog namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Chart_Release: Provides information about the app chart_release namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Container: Provides information about the app container namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Docker: Provides information about the app docker namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Kubernetes: Provides information about the app kubernetes namespace in the TrueNAS CLI. Includes command syntax and common commands.