Skip to content

Commit 423ec0d

Browse files
Document verbose mode and its usage in README
Added documentation for verbose mode in litmusctl.
1 parent 205b977 commit 423ec0d

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,52 @@ litmusctl.exe <command> <subcommand> <subcommand> [options and parameters]
286286
litmusctl version
287287
```
288288

289+
## Verbose Mode
290+
291+
litmusctl supports a `--verbose` (or `-v`) flag to enable detailed logging during command execution. This is useful for debugging and understanding what's happening behind the scenes.
292+
293+
### Usage
294+
295+
Add the `--verbose` or `-v` flag to any litmusctl command:
296+
297+
```shell
298+
litmusctl <command> --verbose
299+
# or
300+
litmusctl <command> -v
301+
```
302+
303+
### What Gets Logged
304+
305+
When verbose mode is enabled, litmusctl will print additional information including:
306+
307+
- API endpoints being accessed
308+
- HTTP request methods and payloads
309+
- Response status codes
310+
- Internal processing steps
311+
- Project and resource details during operations
312+
313+
### Examples
314+
315+
```shell
316+
# Get projects with verbose logging
317+
litmusctl get projects --verbose
318+
319+
# Create a project with detailed logs
320+
litmusctl create project --name my-project -v
321+
322+
# Connect chaos infrastructure with debug information
323+
litmusctl connect chaos-infra --verbose --name my-infra --non-interactive
324+
```
325+
326+
### Default Behavior
327+
328+
By default, litmusctl operates in minimal logging mode, showing only:
329+
- Error messages
330+
- Warning messages
331+
- User-facing output
332+
333+
Use `--verbose` when you need to troubleshoot issues or understand the internal operations of the CLI.
334+
289335
## Development Guide
290336

291337
You can find the local setup guide for **`litmusctl`** [here](DEVELOPMENT.md).

0 commit comments

Comments
 (0)