runem 0.2.0

Awesome runem created by lursight

Run'em: Accelerate Your Development Workflow

Boost Efficiency and Save Time Runem is a flexible, multi-process tool designed to speed up your everyday tasks by running them in parallel. Whether you're testing, linting, or deploying, runem helps you work smarter and faster.

Why Choose Run'em?

• Streamlined Task Management: Configure tasks with ease using declarative .runem.yml files.
• Multiprocess Execution: Run multiple tasks simultaneously, minimizing wall-clock time.
• Optimized for Monorepos: Supports multiple projects and task types, with easy filtering and configuration.
• Detailed Reporting: Get insights into task execution time and efficiency gains.

Contents

• Run'em: Accelerate Your Development Workflow
  • Why Choose Run'em?
  • Contents
• Features At A Glance:
• Using Run'em
  • Installation
  • Quick-start
  • Basic quick-start
    • A more complete quick-start
  • Basic Use
  • Advanced Use
    • Advanced configuration options
    • Custom reports
• Help and job discovery
• Troubleshooting
• Contributing to and supporting runem
  • Development
  • Sponsor
• About runem

Features At A Glance:

• Tagging: Easily run specific job groups (e.g., lint, test, python).
• Phases: Organize tasks by phase (e.g., edit, test, deploy).
• Configurable Options: Customize how jobs are executed using simple options.
• Declarative: Jobs are define using simple YAML in .runem.yml .

Using Run'em

Installation

pip install runem

Quick-start

Basic quick-start

Create the following .runem.yml file at the root of your project:

- job:
    command: echo "hello world!"

Then anywhere in your project run runem to see how and when that task is run, and how long it took:

runem

To see the actual log output you will need to use --verbose as runem hides anything that isn't important. Only failures and reports are considered important.

# Or, to see "hello world!", use --verbose
runem --verbose  # add --verbose to see the actual output

To see how you can control your job use --help:

runem --help

A more complete quick-start

See quick-start docs for more quick-start tips.

Basic Use

See docs on basic use and use-cases for a comprehensive introduction.

Advanced Use

Advanced configuration options

See configuration docs for advanced configuration and use.

Custom reports

See reporting docs for more information on how reporting works.

Help and job discovery

--help is designed to help your team discover what jobs and tasks they can automated. Read more at help and discovery docs.

Troubleshooting

See troubleshooting and known issues docs.

---

Contributing to and supporting runem

Awesome runem created by lursight

Development

Read the CONTRIBUTING.md file.

Sponsor

❤️ Sponsor this project

About runem

The runem mission is to improve developer velocity at Lursight Ltd., read more about the runem mission.