Skip to content

Commit 3e420da

Browse files
committed
added fexec docs
1 parent e4ec73a commit 3e420da

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,5 +94,36 @@ Cleanable[State any]
9494
```
9595

9696
## Command line tool
97+
There's a command line tool for running simple command modules (`framework.CommandModule`).
9798

98-
TODO
99+
Install:
100+
101+
```sh
102+
go install github.com/roboslone/go-framework/cmd/fexec@latest
103+
```
104+
105+
Example config: [.fexec.yaml](https://github.com/roboslone/go-framework/blob/main/.fexec.yaml)
106+
107+
Run:
108+
109+
```sh
110+
fexec --help
111+
112+
# Usage of fexec:
113+
# -c string
114+
# Path to config file (default ".fexec.yaml")
115+
#
116+
# Available modules:
117+
# ci
118+
# depends on lint, test
119+
# install
120+
# $ go get
121+
# lint
122+
# $ golangci-lint run --no-config .
123+
# depends on install
124+
# test
125+
# $ go test ./...
126+
# depends on install
127+
# pre-commit
128+
# depends on lint, test
129+
```

0 commit comments

Comments
 (0)