Skip to content

Commit fc7a3fd

Browse files
committed
Update examples and usage
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent 3d3061b commit fc7a3fd

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,45 @@ See docs at pkg.go.dev: [github.com/alexellis/go-execute](https://pkg.go.dev/git
1010

1111
## go-execute users
1212

13+
[Used by dozens of projects as identified by GitHub](https://github.com/alexellis/go-execute/network/dependents), notably:
14+
1315
* [alexellis/arkade](https://github.com/alexellis/arkade)
1416
* [openfaas/faas-cli](https://github.com/openfaas/faas-cli)
1517
* [inlets/inletsctl](https://github.com/inlets/inletsctl)
18+
* [inlets/cloud-provision](https://github.com/inlets/cloud-provision)
1619
* [alexellis/k3sup](https://github.com/alexellis/k3sup)
20+
* [openfaas/connector-sdk](https://github.com/openfaas/connector-sdk)
1721
* [openfaas-incubator/ofc-bootstrap](https://github.com/openfaas-incubator/ofc-bootstrap)
1822

23+
Community examples:
24+
25+
* [dokku/lambda-builder](https://github.com/dokku/lambda-builder)
26+
* [027xiguapi/pear-rec](https://github.com/027xiguapi/pear-rec)
27+
* [cnrancher/autok3s](https://github.com/cnrancher/autok3s)
28+
* [ainsleydev/hupi](https://github.com/ainsleydev/hupi)
29+
* [andiwork/andictl](https://github.com/andiwork/andictl)
30+
* [tonit/rekind](https://github.com/tonit/rekind)
31+
* [lucasrod16/ec2-k3s](https://github.com/lucasrod16/ec2-k3s)
32+
* [seaweedfs/seaweed-up](https://github.com/seaweedfs/seaweed-up)
33+
* [jsiebens/inlets-on-fly](https://github.com/jsiebens/inlets-on-fly)
34+
* [jsiebens/hashi-up](https://github.com/jsiebens/hashi-up)
35+
* [edgego/ecm](https://github.com/edgego/ecm)
36+
* [ministryofjustice/cloud-platform-terraform-upgrade](https://github.com/ministryofjustice/cloud-platform-terraform-upgrade)
37+
* [mattcanty/go-ffmpeg-transcode](https://github.com/mattcanty/go-ffmpeg-transcode)
38+
* [Popoola-Opeyemi/meeseeks](https://github.com/Popoola-Opeyemi/meeseeks)
39+
* [aidun/minicloud](https://github.com/aidun/minicloud)
40+
1941
Feel free to add a link to your own projects in a PR.
2042

43+
## Main options
44+
45+
* `DisableStdioBuffer` - Discard Stdio, rather than buffering into memory
46+
* `StreamStdio` - Stream stderr and stdout to the console, useful for debugging and testing
47+
* `Shell` - Use bash as a shell to execute the command, rather than exec a binary directly
48+
* `StdOutWriter` - an additional writer for stdout, useful for mutating or filtering the output
49+
* `StdErrWriter` - an additional writer for stderr, useful for mutating or filtering the output
50+
* `PrintCommand` - print the command to stdout before executing it
51+
2152
## Example of exec without streaming to STDIO
2253

2354
This example captures the values from stdout and stderr without relaying to the console. This means the values can be inspected and used for automation.

0 commit comments

Comments
 (0)