Skip to content

Commit 3baec00

Browse files
committed
Add documentation
1 parent 91f32da commit 3baec00

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

cmd/commander/commander.go

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ func createTestCommand() cli.Command {
4747
return cli.Command{
4848
Name: "test",
4949
Usage: "Execute the test suite, by default it will use the commander.yaml from your current directory",
50-
ArgsUsage: "[file] [title]",
50+
ArgsUsage: "[file] [--filter]",
5151
Flags: []cli.Flag{
5252
cli.BoolFlag{
5353
Name: "no-color",
@@ -64,8 +64,15 @@ func createTestCommand() cli.Command {
6464
Usage: "Execute all test files in a directory sorted by file name, this is not recursive - e.g. /path/to/test_files/",
6565
},
6666
cli.StringFlag{
67-
Name: "filter",
68-
Usage: "Filter tests by a given regex pattern. Tests are filtered by its title.",
67+
Name: "filter",
68+
Usage: `Filter tests by a given regex pattern. Tests are filtered by its title.
69+
70+
Example:
71+
test commander.yaml --filter="my test"
72+
73+
Apply multiple filters separated by commas:
74+
test commander.yaml --filter=filter1,filter2
75+
`,
6976
},
7077
},
7178
Action: func(c *cli.Context) error {

0 commit comments

Comments
 (0)