Get a Quote   (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

Shell

  2 minute read.

Last Modified 2022-04-07 16:08 EDT

The SCALE Shell is convenient for running command lines tools, configuring different system settings, or finding log files and debug information. The Shell screen opens with the root user logged in.

Warning: the supported mechanisms for making configuration changes are the TrueNAS WebUI, CLI, and API exclusively. ALL OTHERS ARE NOT SUPPORTED AND WILL RESULT IN UNDEFINED BEHAVIOR AND MAY RESULT IN SYSTEM FAILURE.

Shell

The Set font size slider adjusts the Shell displayed text size. Click RESTORE DEFAULT to reset the Shell font size.

The Shell stores the command history for the current session. Use the keyboard up and down arrow keys to scroll through previously entered commands. Edit the command if desired, then press Enter to re-enter the command. Leaving the Shell screen clears the command history.

The *Shell supports the Home, End, and Delete keys, as well as Tab completion. Type a few letters and press Tab to complete a command name or filename in the current directory. 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 in the Shell.

Entering exit leaves the session. Click Reconnect to start a new session.

Default Shell

Clicking other web interface menus closes the shell session and stops commands running in the Shell screen. zsh is the default Shell, but you can change this by editing the root user in Credentials > Local Users and choosing a different option in the Shell drop-down. Most Linux command-line utilities are available in the Shell.

Tmux allows you to detach sessions in Shell and then reattach them later. Commands continue to run in a detached session.

Experimental CLI

The experimental SCALE command-line interface (CLI) lets you directly configure SCALE features.

SCALE CLI is experimental and still in active development. We are not accepting bug reports or feature requests at this time.

To switch to the experimental CLI, enter cli. Basic commands are:

  • .. - up one level
  • exit - exit the CLI
  • ls - list the available directories and commands
  • ? or help - list the built-in commands

The CLI features an auto-suggest mechanism for commands. When you begin typing a command, the CLI shows a list of all matching commands.

ScaleCLIAutocomplete

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.