Skip to main content

A command runner with rich formatting

Project description

Rich Run

GitHub License PyPI - Version Downloads

A command runner with rich formatting that wraps your commands in elegant panels and provides clear success/failure feedback.

Example

Features

  • 🎨 Command output with rich formatting
  • ⏰ Timestamps for command execution
  • ✅ Clear success/failure indicators
  • 📦 Easy installation via pip/pipx
  • 🚀 Drop-in replacement for running commands

Installation

Via pipx (recommended)

pipx install rich-run

Via pip

pip install rich-run

Prerequisites

This package depends on rich-cli. If it's not already installed, you can install it with:

pipx install rich-cli

Usage

Simply prepend rich-run to any command you want to run:

# Run a simple command
rich-run echo 'Hello, World!'

# Run a more complex command
rich-run python -c "print('This is a Python script')"

# Run commands with arguments
rich-run ls -la /usr/local

# Chain commands (note: use quotes to preserve shell behavior)
rich-run "echo 'First command' && echo 'Second command'"

Example Output

When you run a command with rich-run, you'll see:

  1. A blue panel showing the command being executed with a timestamp
  2. A separator line
  3. The actual command output
  4. Another separator line
  5. A success (green) or failure (red) message with the exit code

Development

To set up for development:

git clone https://github.com/tanganke/rich-run.git
cd rich-run
pip install -e .

License

MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

rich_run-0.1.2.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

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

rich_run-0.1.2-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file rich_run-0.1.2.tar.gz.

File metadata

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

File hashes

Hashes for rich_run-0.1.2.tar.gz
Algorithm Hash digest
SHA256 fd8e20d5105f5e8c8fae02a2f0d6562500f398d317105305a714d72449eba999
MD5 c07d0ef51343ee2f6fce1fc9c6f5ae4f
BLAKE2b-256 40e8301c62491809978e473ee19b1ef6aebcb82843c2fca34cd6d10e808ce7e7

See more details on using hashes here.

Provenance

The following attestation bundles were made for rich_run-0.1.2.tar.gz:

Publisher: publish.yml on tanganke/rich-run

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

File details

Details for the file rich_run-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: rich_run-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for rich_run-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 15a94a030013be901aecd54884aa351cacd4f7f68f2dc7657472eb105f112078
MD5 d399dcd55c2868151f24ea4a971a4dbe
BLAKE2b-256 7adb5d9366218ac9986d14f8a16b259a2a57f4e27604b513f90c7a0a3271b71f

See more details on using hashes here.

Provenance

The following attestation bundles were made for rich_run-0.1.2-py3-none-any.whl:

Publisher: publish.yml on tanganke/rich-run

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