3 minute read.Last Modified 2023-11-17 11:13 EST
The SCALE Shell is convenient for running command lines tools, configuring different system settings, or finding log files and debug information.
Warning! The supported mechanisms for making configuration changes are the TrueNAS WebUI, CLI, and API exclusively. All other are not supported and result in undefined behavior that can result in system failure!
The Set font size slider adjusts the Shell displayed text size. Restore Default resets the font size to default.
The Shell stores the command history for the current session.
Leaving the Shell screen clears the command history.
Click Reconnect to start a new session.
This section provides keyboard navigation shortcuts you can use in Shell.
Action Keyboard/Command Description Scroll up Up arrow Scroll up through previous commands. Scroll down Down arrow Scroll down through following commands. Re-enter command Enter After entering a command, press Enter to re-enter the command. Top of screen Home Moves the cursor to the top of the screen entries and results. Bottom of screen End Moves the cursor to the bottom of the screen command entries and results. Delete Delete Deletes what you highlight. Auto-fill text Tab Type a few letters and press Tab to complete a command name or filename in the current directory. right-click Right-clicking in the terminal window displays a reminder about using Command+c and Command+v or Ctrl+Insert and Shift+Insert for copy and paste operations. Exit to root prompt
exit leaves the session.
Copy text Ctrl+Insert Enter Ctrl+Insert to copy highlighted text in Shell. Paste text Shift+Insert Enter Shift+Insert to paste copied text in Shell. Kill running process Ctrl+c Enter Ctrl+c to kill a process running in Shell. For example, the
zsh is the default shell, but you can change this by going to Credentials > Local Users. Select the admin or other user to expand it. Click Edit to open the Edit User screen. Scroll down to Shell and select a different option from the dropdown list. Most Linux command-line utilities are available in the Shell. Click Save.
Admin users can set the Shell to default to the TrueNAS CLI by selecting TrueNAS CLI in Shell on the Edit User screen. See SCALE CLI Reference Guide for more information on using the TrueNAS CLI. To change the Shell to default to the Console Setup Menu, select TrueNAS Console in Shell on the Edit User screen.
Clicking other SCALE UI menus options closes the shell session and stops commands running in the Shell screen.
Tmux allows you to detach sessions in Shell and then reattach them later. Commands continue to run in a detached session.
The new SCALE command-line interface (CLI) lets you directly configure SCALE features using namespaces and commands based on the SCALE API.
TrueNAS CLI is still in active development. We are not accepting bug reports or feature requests at this time.
See SCALE CLI Reference Guide for more information on using the TrueNAS CLI.
We intend the CLI to be an alternative method for configuring TrueNAS features. Because of the variety of available features and configurations, we include CLI-specific instructions in their respective UI documentation sections.