Skip to main content

A simple CLI tool to run commands from a YAML file.

Project description

UnRun

PyPI downloads per month PyPI version GitHub last commit GitHub issues

🚀 A simple CLI tool to run commands from a YAML file.

Installation

pip install unrun

Usage & Features

Create an unrun.yaml file in your project root:

hello: echo "Hello, world!"
foo:
    bar: echo "This is foo bar"
baz: !and
    - echo "This is baz item 1"
    - echo "This is baz item 2"

Single Command

You can run a single command by specifying its key:

unrun hello

Run the command:

echo "Hello, world!"

Nested Command

You can run nested commands by specifying the full path:

unrun foo.bar

Run the command:

echo "This is foo bar"

List Command

To run all commands under a key that contains a list, you can simply specify the key:

unrun baz

Run the commands:

echo "This is baz item 1" && echo "This is baz item 2"

Supports !and, !or and !; YAML tags to combine commands.

Configuration

Configure Priority

  1. CLI arguments
  2. Environment variables: UNRUN_{key}
  3. local unrun.config.yaml
  4. global ~/unrun.config.yaml

Available keys

  • --file: Specify a custom YAML file (default is unrun.yaml).
  • --include: Include specified keys from the YAML file.
  • --exclude: Exclude specified keys from the YAML file.

License

MIT License

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

unrun-0.3.5.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

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

unrun-0.3.5-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file unrun-0.3.5.tar.gz.

File metadata

  • Download URL: unrun-0.3.5.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for unrun-0.3.5.tar.gz
Algorithm Hash digest
SHA256 64138d5d38259a101ddd34129eb358a2a3d6614d4d4aaf79c07ed1894a612642
MD5 063e667bfd6082821877ade50776951b
BLAKE2b-256 da5dd1b1547f33a247e9f5243c3fdab653b9de7b2ad03917996e164567b1202c

See more details on using hashes here.

File details

Details for the file unrun-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: unrun-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for unrun-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0de49a709818b254480554eef3067d5f8c4b87816b11bc8599477e1fb66d6af9
MD5 9d68b0626bc0c525c99c26ac23dca4ed
BLAKE2b-256 b2a3a88d605007e8494c5ee266f5ab5cb0a307e830865ed1f36403bf89fe33b7

See more details on using hashes here.

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