TrueNAS SCALETrueNAS 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.

Using Shell

The SCALE Shell is convenient for running command line tools, configuring different system settings, or finding log files and debug information.

Warning! The supported mechanisms for making configuration changes are the TrueNAS WebUI and API exclusively. All other are not supported and result in undefined behavior that can result in system failure!
Shell Screen
Figure 1: Shell Screen

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.

Scroll upUp arrow expand_lessScroll up through previous commands.
Scroll downDown arrow expand_moreScroll down through following commands.
Re-enter commandEnterAfter entering a command, press Enter to re-enter the command.
Top of screenHomeMoves the cursor to the top of the screen entries and results.
Bottom of screenEndMoves the cursor to the bottom of the screen command entries and results.
DeleteDeleteDeletes what you highlight.
Auto-fill textTabType a few letters and press Tab to complete a command name or filename in the current directory.
right-clickRight-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 promptexitEntering exit leaves the session.
Copy textCtrl+InsertEnter Ctrl+Insert to copy highlighted text in Shell.
Paste textShift+InsertEnter Shift+Insert to paste copied text in Shell.
Kill running processCtrl+cEnter Ctrl+c to kill a process running in Shell. For example, the ping command.

Changing the Default Shell

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. Options are nologin, TrueNAS CLI, TrueNAS Console, sh, bash, rbash, dash, tmux, and zsh. Click Save.

Admin users can set the Shell to default to the TrueNAS Console by selecting 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.