Shell Command

Run the CLI in an interactive shell

Description: Run the CLI in an interactive shell (REPL). Once inside the shell, run any ksm command by typing its name directly, without the ksm prefix, and without re-authenticating between commands.

format: ksm shell

Example:

$ ksm shell

██╗  ██╗███████╗███╗   ███╗     ██████╗██╗     ██╗
██║ ██╔╝██╔════╝████╗ ████║    ██╔════╝██║     ██║
█████╔╝ ███████╗██╔████╔██║    ██║     ██║     ██║
██╔═██╗ ╚════██║██║╚██╔╝██║    ██║     ██║     ██║
██║  ██╗███████║██║ ╚═╝ ██║    ╚██████╗███████╗██║
╚═╝  ╚═╝╚══════╝╚═╝     ╚═╝     ╚═════╝╚══════╝╚═╝

Current Version: 1.5.0

Running in shell mode. Type 'quit' to exit.

KSM Shell (? for help) > secret list

 UID                     Record Type  Title
 ----------------------- ------------ -----------
 A_ok8pstlrCr5o84Ac9-hg  login        My Login

KSM Shell (? for help) > quit

Once inside the shell, run every ksm sub-command by its bare name: secret list, folder list, profile list, and so on. Do not prefix commands with ksm while already in the shell.

---

Sub-Commands (available inside the shell)

Sub-Command	Description
quit	Exit the shell and return to your terminal.
help	Show the top-level command list and options, the same output as ksm --help.

Type ? at the shell prompt for the same command list and options that help and ksm --help show.

---

Session-Wide Options

Any global option passed when starting the shell (--ini-file, --profile-name/-p, --output/-o, --color/--no-color, --cache/--no-cache, --log-level) applies to every command in that session. You do not need to repeat it on each command. An option typed on an individual shell line overrides the session value for that line only.

Example:

$ ksm --profile-name production shell

KSM Shell (? for help) > secret list
# uses the "production" profile

KSM Shell (? for help) > secret list --profile-name staging
# uses "staging" for this line only

KSM Shell (? for help) > secret list
# back to "production"

---

Platform Notes

Windows: File paths containing backslashes (for example --ini-file C:\keeper\keeper.ini) and secret values or arguments containing # are parsed correctly inside the shell on Windows.

If the terminal cannot display the banner's box-drawing characters (for example, when output is piped), the shell uses a plain-text banner instead. This does not affect command functionality.

---