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.6.tar.gz (7.1 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.6-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: unrun-0.3.6.tar.gz
  • Upload date:
  • Size: 7.1 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.6.tar.gz
Algorithm Hash digest
SHA256 6bc3d9bb17bb0a7918a993c8bc716de8f4bb06a1d149fb9429bb5c78cdfd8f93
MD5 ea81b848800eade3813813d8841feddd
BLAKE2b-256 be08244d08ebf8afbaf818c7dceea650216b926000b7caaad60f041690436125

See more details on using hashes here.

File details

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

File metadata

  • Download URL: unrun-0.3.6-py3-none-any.whl
  • Upload date:
  • Size: 7.5 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 692647a2361c5971b2e7c4a68ad8e9a9b791e7abb410696c75d764d89ec74018
MD5 7b1f99fad9a61fc2798ce54b512501e2
BLAKE2b-256 b1f800c457c40f8344bc6c35dd1d729922f5761f3b0f807918b6f3748acdac30

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