lakruzz/play repository overview

⁠Play

Play allows you to define shell executions as configurations. You just provide the YAML file and the play script will execute it. It allows you to easily reuse snippets*

⁠To use this utility as a CLI simply run

docker run lakruzz/play play

To learn more you can use switches --man or --help

⁠To use this utility as a job on Circle CI

The following Circle CI job is a snippet from the proflow/github/JAM-stack template for Circle CI⁠ (have a look at the two files in the .circleci folder)

  prod-deploy:
    working_directory: /app/_site
    docker:
      - image: lakruzz/play:latest
        environment:
          PLAY_TARGET_GH_REPO:   lakruzz/stage-circle-lab
          PLAY_USER_NAME:        Circle CI by @Lakruzz
          PLAY_USER_EMAIL:       [email protected]
    steps:
      - restore_cache:
          keys:
            - the-built-repo-{{ .Revision }}
      - run:
          name: Deploy to GitHub Pages
          command: play --manuscript ../.circleci/play-proflow-cci-gh.yml --part ghpages_deploy

⁠Reference

The manual is available like this

docker run lakruzz/play play --help

• NAME⁠
• SYNOPSIS⁠
• OPTIONS⁠
  • REQUIRED⁠
  • OPTIONAL⁠
  • PROTIP⁠
• DESCRIPTION⁠

⁠NAME

PLAY - A declarative approach to executing - all kinds of stuff

⁠SYNOPSIS

  PLAY --part PART [--manuscript MANUSCRIPT] [--[no]verbose] [--dryrun]
  PLAY --help | --man

⁠OPTIONS

⁠REQUIRED

  --part PART

The part to play from the manuscript

⁠OPTIONAL

  --manuscript MANUSCRIPT

The manuscript that contains the different parts to play. This option overrides the default manuscript.

  --[no]verbose

Prints the whole part from the manuscript before the play begins, and prints each shell commands before execution. The default is --[no]verbose, but can be set in the manuscript, or overruled using this option.

--dryrun

Implies --verbose. Prints all the verbose information, but doesn't actually execute anything.

⁠PROTIP

Options can be applied with double or single dashes as you like, so both --verbose and -verbose are valid. You can even abbreveate the option name, it will remain valid as long as it's unique among all options.

Example: since there are no other options except --verbose that begins with 'v' it means that even -v is valid.

⁠DESCRIPTION

Copyright

Lars Kruse, 2018, www.lakruzz.com⁠

License

GPL v3.0

Repository

github.com/lakruzz/play⁠

Support and feeback

Use the issues⁠ in the repo.