Skip to main content

Preview and confirm scripts before executing them.

Project description

hold-your-shell

hold-your-shell is a command line program (TUI) that previews shell scripts (or any shebang script) in a pager, and asks the user to confirm execution.

This single file program is written for Python 3.x and only uses the stdlib.

image

Install

Pip install:

pip install hold-your-shell

Manual install:

HY_BIN=~/.local/bin/hold-your-shell
mkdir -p $(dirname ${HY_BIN})

wget -O ${HY_BIN} https://raw.githubusercontent.com/EnigmaCurry/hold-your-shell/refs/heads/master/hold_your_shell/hold_your_shell.py

chmod +x ${HY_BIN}

Usage

  • Pipe any script to the stdin of hold-your-shell.
  • The script will be previewed on the first tab shown: Script Preview.
  • Press TAB to cycle through the other tabs, including Env Vars.
  • Use the up and down arrow keys (or j and k) to scroll the text.
  • After reviewing the script and env vars, choose whether or not you you want to run the script. Using the left or right arrows, select Yes or No. Press Enter to confirm your selection.

Examples

Read from stdin

echo "whoami" | hold-your-shell
echo -e '#!/bin/python\nprint("Hello from Python!")' | hold-your-shell
cat <<'EOF' | hold-your-shell
echo "What is your name?"
read NAME
echo "Hello $NAME"
EOF
curl https://get.docker.com/ | hold-your-shell

Read from file

cat <<EOF > test.txt
#!/bin/env python
print("Hello from Python!")
EOF

hold-your-shell --consume test.txt

--consume will delete the input file immediately after it reads it.

Linger

echo whoami | hold-your-shell --linger

--linger will have the program remain running after completion of the script until a key is pressed.

Development

See DEVELOPMENT.md

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hold_your_shell-0.1.4.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hold_your_shell-0.1.4-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file hold_your_shell-0.1.4.tar.gz.

File metadata

  • Download URL: hold_your_shell-0.1.4.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hold_your_shell-0.1.4.tar.gz
Algorithm Hash digest
SHA256 856e799930385d6cd10af0abe420997b10748a938630e6b8af8977bd0d3bf2e5
MD5 395f515523939d4d745871d2896e0dee
BLAKE2b-256 c1b704ae4c61a3ed23dbd0b223dc34009865f104b7044844ee8f35a33727bd3d

See more details on using hashes here.

Provenance

The following attestation bundles were made for hold_your_shell-0.1.4.tar.gz:

Publisher: publish.yml on EnigmaCurry/hold-your-shell

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hold_your_shell-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for hold_your_shell-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ed30e903a127d8c5e4d702f70155408deb04b8422b9471fb49076ec5aa19f1a4
MD5 b36c1334897b0209e1eff166c6a84b9c
BLAKE2b-256 2beb0485efb0f0f05885cd59878e35f224d6d3e80f5824611275e7ddddd3f5f5

See more details on using hashes here.

Provenance

The following attestation bundles were made for hold_your_shell-0.1.4-py3-none-any.whl:

Publisher: publish.yml on EnigmaCurry/hold-your-shell

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page