Skip to content

Commit c456116

Browse files
committed
update docs to show env vars and config colors
1 parent 584ef1e commit c456116

File tree

1 file changed

+28
-11
lines changed

1 file changed

+28
-11
lines changed

README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,6 @@ Why? Because your bash script should be quiet and shy-like (...and not such a lo
2323
- [x] Control which failing command should halt execution
2424

2525
## Installation
26-
**Go tools**
27-
```bash
28-
go get github.com/wagoodman/bashful
29-
```
30-
31-
**Mac**
32-
```bash
33-
brew tap wagoodman/bashful
34-
brew install bashful
35-
```
36-
or download a Darwin build from the releases page.
3726

3827
**Ubuntu/Debian**
3928
```bash
@@ -47,6 +36,18 @@ wget https://github.com/wagoodman/bashful/releases/download/v0.0.10/bashful_0.0.
4736
rpm -i bashful_0.0.10_linux_amd64.rpm
4837
```
4938

39+
**Mac**
40+
```bash
41+
brew tap wagoodman/bashful
42+
brew install bashful
43+
```
44+
or download a Darwin build from the releases page.
45+
46+
**Go tools**
47+
```bash
48+
go get github.com/wagoodman/bashful
49+
```
50+
5051
## Getting Started
5152
**There are a ton of examples in the [`example/`](https://github.com/wagoodman/bashful/tree/master/example) dir**, but here are a few:
5253

@@ -123,6 +124,15 @@ bashful bundle install.yaml
123124
```
124125
*Note: the bundle feature is pretty experimental right now.*
125126

127+
You can even persist environment variables across tasks:
128+
```yaml
129+
tasks:
130+
- cmd: export VAR1=isnowset
131+
- cmd: eval "export VAR2=isnowreallyset"
132+
- cmd: echo ${VAR1} ${VAR2}
133+
```
134+
*Note: you cannot persist environment variables from a parallel step.*
135+
126136
**There are a ton of examples in the [`example/`](https://github.com/wagoodman/bashful/tree/master/example) dir.** Go check them out!
127137

128138
## Configuration Options
@@ -138,6 +148,13 @@ config:
138148
# hide all subtasks after section completion
139149
collapse-on-completion: false
140150
151+
# change the colors of the vertical progress bar for a task in a particular state.
152+
# this should be a number from the 256 color palette.
153+
success-status-color: 10
154+
running-status-color: 22
155+
pending-status-color: 22
156+
error-status-color: 160
157+
141158
# by default the screen is updated when an event occurs (when stdout from
142159
# a running process is read). This can be changed to only allow the
143160
# screen to be updated on an interval (to accomodate slower devices).

0 commit comments

Comments
 (0)