Skip to content

Commit f84a091

Browse files
Update README.md
1 parent 5929e20 commit f84a091

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -66,20 +66,22 @@ The Pizza Test CLI provides an efficient way to run and manage tests directly fr
6666
### Commands and Options
6767

6868
| Command | Description | Notes |
69-
|----------------------------------|-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|
70-
| `--version` | Displays the current version of Pizza Test. | Useful for verifying the version of the tool in use. |
71-
| `--help` | Shows help message with usage instructions. | Provides a quick reference for all available commands. |
72-
| `--dry-run` | Perform a dry run without executing commands. | Ideal for verifying test selection criteria before actual execution. |
73-
| `--host` | Shows info about the current host system. | Useful for looking up system you are running test on. |
74-
| `run` | Execute tests with optional parameters. | Supports additional options like `--fail-fast` and `--repeat`. |
75-
| `filter` | Filter tests based on criteria. | Options include filtering by test name, suite name, or tags. |
76-
| `sort` | Sort tests by specified criteria. | Allows sorting in ascending or descending order. |
77-
| `shuffle` | Shuffle tests with optional parameters. | Includes options for specifying a seed or shuffle criteria. |
78-
| `color=<mode>` | Set color mode (enable, disable, auto). | Enhances readability in supported terminals. |
79-
| `config=<file>` | Specify a configuration file (must be pizza_test.ini). | Allows loading custom settings for test execution. |
80-
| `theme=<name>` | Set the theme (pizza, catch, doctest, etc.). | Customizes the appearance of test output. |
81-
| `verbose=<level>` | Set verbosity level (plain, ci, doge). | Adjusts the level of detail in test output. |
82-
| `timeout=<seconds>` | Set a timeout for test execution. | Ensures tests do not exceed the specified duration, helping to identify long-running tests. |
69+
|-----------------------------------|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|
70+
| `--version` | Show version information. | Useful for verifying the version of the tool in use. |
71+
| `--dry-run` | Perform a dry run without executing commands. | Ideal for verifying test selection criteria before actual execution. |
72+
| `--host` | Show information about the current host. | Useful for looking up the system you are running tests on. |
73+
| `--help` | Show this help message. | Provides a quick reference for all available commands. |
74+
| `run` | Execute tests with optional parameters. | Supports additional options like `--fail-fast` and `--repeat`. |
75+
| `filter` | Filter tests based on criteria. | Options include filtering by test name, suite name, or tags. |
76+
| `sort` | Sort tests by specified criteria. | Allows sorting in ascending or descending order. |
77+
| `shuffle` | Shuffle tests with optional parameters. | Includes options for specifying a seed or shuffle criteria. |
78+
| `show` | Show test cases with optional parameters. | Useful for listing and inspecting available test cases. |
79+
| `color=<mode>` | Set color mode (`enable`, `disable`, `auto`). | Enhances readability in supported terminals. |
80+
| `config=<file>` | Specify a configuration file (must be `pizza_test.ini`). | Allows loading custom settings for test execution. |
81+
| `theme=<name>` | Set the theme (`fossil`, `catch`, `doctest`, etc.). | Customizes the appearance of test output. |
82+
| `timeout=<seconds>` | Set the timeout for commands (default: 60 seconds). | Ensures commands do not exceed the specified duration, helping to identify long-running tests.|
83+
84+
> **Note:** In addition to the `--help` option, Pizza Test CLI supports `help` and subcommand-specific help commands. You can use `help <command>` (e.g., `help run`) or `<command> help` (e.g., `run help`) to display detailed usage information for any command or subcommand. This provides flexible ways to access documentation directly from the terminal.
8385
8486
## Configure Build Options
8587

0 commit comments

Comments
 (0)