RunCommands Documentation

RunCommands is a simple, Python 3.7+ command runner that automatically generates argparse-style console scripts from functions.

A basic run looks like this:

> run build-static deploy --version 1.0

In this example, two commands, build-static and deploy, are being run.

Some nice things about using argparse behind the scenes is that usage is familiar and help is built in:

> run deploy --help
usage: deploy [-h] [-v VERSION] ...

Deploy a new version

Quick Start

Check out the Quick Start to get up and running.

Links

• Source Code (GitHub)

Contents

• Installation
  • Development
  • Console Scripts
  • Shell Completion
• Quick Start
  • Summary
  • Details
• Defining Commands
  • Listing Commands
  • Showing a Command’s Help/Usage
• Console Scripts
  • Console Scripts with Subcommands
• Built In Commands
  • Copy files locally
  • Sync files with remote
  • Git version
  • Run local commands
  • Run remote commands
• Configuration
  • Order of Precedence
  • Interpolation
• API Docs
  • command
  • collection
  • args
  • result
  • run
  • runnner
  • exc
  • completion
  • util

Indices and tables

• Index
• Module Index
• Search Page