Skip to content

Commit

Permalink
Merge 224efba into ce32742
Browse files Browse the repository at this point in the history
  • Loading branch information
m3brown committed Dec 5, 2021
2 parents ce32742 + 224efba commit fcc6770
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 25 deletions.
48 changes: 24 additions & 24 deletions README.md
Expand Up @@ -39,19 +39,19 @@ Suppose we have the following `plz.yaml` file:

```yaml
commands:
- id: run
cmd: ./manage.py runserver
- id: test
cmd:
- ./manage.py test
- yarn test
- id: setup
cmd:
- poetry install
- poetry run ./manage.py migrate
- yarn install
- id: ls
cmd: ls
run:
cmd: ./manage.py runserver
test:
cmd:
- ./manage.py test
- yarn test
setup:
cmd:
- poetry install
- poetry run ./manage.py migrate
- yarn install
ls:
cmd: ls
```

The following commands would be available:
Expand All @@ -78,9 +78,9 @@ Print the yaml schema for any defined command with `plz help <command>`:
> plz help test
[INFO] Using config: plz.yaml
id: test
cmd:
- poetry run python -m pytest
test:
cmd:
- poetry run python -m pytest
```

### Environment variables
Expand All @@ -90,20 +90,20 @@ Environment variables can be set for an individual command or globally for all c
```yaml
# env variable for an individual command
commands:
- id: run
cmd: ./manage.py runserver
- id: test
cmd: ./manage.py test
env:
DJANGO_SETTINGS_MODULE: myapp.settings.test
run:
cmd: ./manage.py runserver
test:
cmd: ./manage.py test
env:
DJANGO_SETTINGS_MODULE: myapp.settings.test
```

```yaml
global_env:
ACCESS_TOKEN: 12345
commands:
- id: run
cmd: ./manage.py runserver
run:
cmd: ./manage.py runserver
```

### Globbing
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
@@ -1,6 +1,6 @@
[tool.poetry]
name = "plz-cmd"
version = "1.0.0"
version = "1.0.1"
description = "command line app for running configurable shell commands"
readme = "README.md"
authors = ["Mike Brown <mike.brown@excella.com>"]
Expand Down

0 comments on commit fcc6770

Please sign in to comment.