Installation
In addition to the shell-command-logger itself, some dependencies may need to be installed to make it work best.
See the dependencies section below.
shell-command-logger
Internet connected system
The simplest (and recommended) way to install scl is with pip.
You can use the following command to install or update it to the latest released version and install all optional Python dependencies:
python3 -m pip install -U shell-command-logger[full]
If you do not have pip installed, you may first want to install it:
python3 -m ensurepip --upgrade
Non-internet connected system
You can also install this on an system not directly connected to the Internet, as long as you can put files there (via SSH, SMB, thumbstick). Just download/create a zip of this repository, copy it to your target system, unzip it there and run the following command:
python3 -m pip install .
If pip is not installed, you can also add the src folder of this repository to the PATH environment variable.
After logging out and in again, the scl binary should be available.
Dependencies
You can check for missing dependencies with the following command:
scl check
| Dependency | Required | Description |
|---|---|---|
| Python 3.9+ | yes | Required since the program is written in Python. May work with older Python versions if type hints are removed. |
| util-linux | yes | Installed on most Linux machines by default. Contains: - script: used for recording commands - scriptreplay: used for playing pack commands |
| termcolor 1.1.0+ | no | Used for colored output. Automatially installed when you install using the recommended way (with pip). |
| dateutil | no | Used for parsing dates. When installed natural date formats such as Jan 1, 2000 can be used. |
| grep | no | Installed on most Linux machines by default. Used for searching command output. |
| Interactive selection tool | no | Used for selecting which command to replay. Without this you need to manually pass the right file. For compatible programs see section below. |
Interactive selection tool
If you want to replay commands on the machine, it is highly recommended to install fzf or an graphical alternative such as dmenu. The only requirement is that the tool reads choices from standard input (one choice per line) and writes the selected value to standard output.
The command used to lauch the tool should then be set with the following command:
scl config --set fzf-command <command>
For example:
scl config --set fzf-command 'dmenu -l 20 -p "Replay command"'