# SuperShell: TUI Vault Browser

<figure><img src="https://762006384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJXOXEifAmpyvNVL1to%2Fuploads%2Fhi0FpZMC07QPfkeGC4Gq%2FKeeper%20SuperShell.png?alt=media&#x26;token=9fd17189-d518-475c-b9bd-69424679bb3d" alt=""><figcaption></figcaption></figure>

## Overview

Keeper SuperShell is a full-screen Terminal User Interface (TUI) for managing your Keeper vault and executing commands in a graphical shell. It provides a keyboard-driven (vim) style navigation, optimized for power users and developers.

{% hint style="info" %}
Requires Commander version 17.2.2 or newer
{% endhint %}

<figure><img src="https://762006384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJXOXEifAmpyvNVL1to%2Fuploads%2FwKXeY6v6DE9cTeYSVbQD%2Fsupershell.gif?alt=media&#x26;token=2c73a21a-b0f1-41ea-8b56-a8d273d54f24" alt=""><figcaption></figcaption></figure>

## Getting Started

Launch SuperShell with `supershell` or `ss` command:

```
keeper supershell
```

If you're already in the Keeper shell, simply type:

```
supershell
```

## Feature Overview

<figure><img src="https://762006384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJXOXEifAmpyvNVL1to%2Fuploads%2FIbmwImkr90fwAQi77sBq%2FScreenshot%202026-01-28%20at%203.18.00%E2%80%AFPM.png?alt=media&#x26;token=65455ed6-011a-4d5a-87dc-fdb90bf55033" alt=""><figcaption></figcaption></figure>

SuperShell displays a split-pane interface:

* Top pane - Search input, account info, and device status
* Left pane - Folder tree with nested folders and records
* Right pane - Folder and Record details (normal or JSON view)
* Bottom pane - Command shell and terminal output, use `Ctrl+\` to show/hide

### Keyboard Navigation

SuperShell supports vi-style keyboard navigation for efficient usage over SSH sessions or within any standard system terminal. All functionality can be accomplished without taking your hands off the keyboard. For example, the `j` and `k` keys navigate up and down, and `tab` switches between the search, folder tree and detail panes. When a pane is selected, vi commands can be used to control scrolling. The shortcuts are listed below.

### Command Pane

When the command pane is displayed, Commander commands can be executed and the output is displayed in the terminal window.

| Key                                                 | Action                                                  |
| --------------------------------------------------- | ------------------------------------------------------- |
| <h3> <code>Ctrl + \</code> </h3>                    | Open the bottom command shell pane with terminal output |
| <h3><code>Tab</code> or <code>Shift+Tab</code></h3> | Cycle between visible panes                             |
| <h3><code>!</code></h3>                             | Exit to the standard Keeper Commander shell             |

### Basic Movement

| Key                                       | Action          |
| ----------------------------------------- | --------------- |
| <h3><code>j</code> or <code>↓</code></h3> | Move down       |
| <h3><code>k</code> or <code>↑</code></h3> | Move up         |
| <h3><code>h</code> or <code>←</code></h3> | Collapse folder |
| <h3><code>l</code> or <code>→</code></h3> | Expand folder   |
| <h3><code>g</code></h3>                   | Go to top       |
| <h3><code>G</code></h3>                   | Go to bottom    |

### Page Navigation

| Key                          | Action               |
| ---------------------------- | -------------------- |
| <h3><code>Ctrl+d</code></h3> | Half page down       |
| <h3><code>Ctrl+u</code></h3> | Half page up         |
| <h3><code>Ctrl+e</code></h3> | Scroll down one line |
| <h3><code>Ctrl+y</code></h3> | Scroll up one line   |
| <h3><code>Ctrl+f</code></h3> | Full page down       |
| <h3><code>Ctrl+b</code></h3> | Full page up         |

### Focus Cycling

| Key                             | Action                        |
| ------------------------------- | ----------------------------- |
| <h3><code>Tab</code></h3>       | Cycle: Tree → Detail → Search |
| <h3><code>Shift+Tab</code></h3> | Cycle backwards               |
| <h3><code>/</code></h3>         | Focus search input            |
| <h3><code>Esc</code></h3>       | Clear search / Return to tree |

### Search

Press `/` to activate search mode or use the `tab` key. SuperShell provides live incremental search that filters as you type.

| Key                                           | Action                                      |
| --------------------------------------------- | ------------------------------------------- |
| <h3><code>/</code></h3>                       | Start search                                |
| <h3><code>Enter</code> or <code>↓</code></h3> | Navigate to results                         |
| <h3><code>Ctrl+U</code></h3>                  | Clear search input                          |
| <h3><code>Esc</code></h3>                     | Clear search and restore previous selection |

### Copying Values

SuperShell makes it easy to copy record fields to your clipboard.

| Key                     | Action                    |
| ----------------------- | ------------------------- |
| <h3><code>p</code></h3> | Copy password             |
| <h3><code>u</code></h3> | Copy username             |
| <h3><code>c</code></h3> | Copy entire record (JSON) |
| <h3><code>w</code></h3> | Copy URL                  |
| <h3><code>i</code></h3> | Copy record UID           |

When running SuperShell on your local device, you can also click on any line to copy the value to the clipboard.

<figure><img src="https://762006384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJXOXEifAmpyvNVL1to%2Fuploads%2FHxONCKqfGdmOEdvMHfZj%2FScreenshot%202026-01-28%20at%203.25.54%E2%80%AFPM.png?alt=media&#x26;token=273e18e0-0058-45ab-a95e-1ad3967f8b03" alt=""><figcaption></figcaption></figure>

### View Modes

When a Keeper record is selected, SuperShell offers two view modes that toggle between normal and JSON view. Press `t` to toggle.

<figure><img src="https://762006384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJXOXEifAmpyvNVL1to%2Fuploads%2FIzp27dm25FHt1hA3uoDJ%2FScreenshot%202026-01-04%20at%2012.24.37%E2%80%AFPM.png?alt=media&#x26;token=ca2615a7-4ff6-471d-8d5c-2b746f675e89" alt=""><figcaption><p>Normal Record View</p></figcaption></figure>

<figure><img src="https://762006384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJXOXEifAmpyvNVL1to%2Fuploads%2FaPmeXkiWCYfMRrprMvh1%2FScreenshot%202026-01-04%20at%2012.24.53%E2%80%AFPM.png?alt=media&#x26;token=91374fdd-be4d-47b2-9523-49c0a34a273c" alt=""><figcaption><p>JSON Record View</p></figcaption></figure>

### JSON View

Displays the raw JSON representation of the record, useful for:

* Viewing all record data
* Debugging record structure
* Copying complete record data

| Key                     | Action                                  |
| ----------------------- | --------------------------------------- |
| <h3><code>t</code></h3> | Toggle between `Detail` and `JSON` view |

### Sensitive Data

By default, SuperShell masks sensitive fields that contain "password", "secret", or "passphrase" in their names.

| Key                     | Action                                  |
| ----------------------- | --------------------------------------- |
| <h3><code>m</code></h3> | Toggle mask/unmask for sensitive fields |

### TOTP Codes

For records with Two-Factor Authentication configured, SuperShell displays:

* The current TOTP code
* A countdown bar showing time remaining
* Automatic refresh every second

<figure><img src="https://762006384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJXOXEifAmpyvNVL1to%2Fuploads%2FsRGUqnL447sNd4grClOV%2FScreenshot%202026-01-04%20at%2012.44.12%E2%80%AFPM.png?alt=media&#x26;token=7537ed7c-9b2b-4865-84b2-793c0e6a6703" alt=""><figcaption></figcaption></figure>

## Additional Actions

| Key                     | Action                           |
| ----------------------- | -------------------------------- |
| <h3><code>d</code></h3> | Sync vault (refresh from server) |
| <h3><code>W</code></h3> | Show user information            |
| <h3><code>D</code></h3> | Show device information          |
| <h3><code>P</code></h3> | Open preferences (color themes)  |
| <h3><code>?</code></h3> | Show keyboard shortcuts help     |

## Exiting SuperShell

| Key                          | Action                     |
| ---------------------------- | -------------------------- |
| <h3><code>!</code></h3>      | Exit to Keeper shell       |
| <h3><code>Ctrl+q</code></h3> | Quit SuperShell completely |

## Feature Requests

We plan to add many new Vault and KeeperPAM features to SuperShell. Please submit all feature requests by [opening an issue](https://github.com/Keeper-Security/Commander/issues).