Skip to content

Commit e2ca5d7

Browse files
jingle2008claude
andcommitted
Update README: add log_level flag, fix log_format values, link user manual
- Add missing --log_level flag to global flags table - Fix --log_format to list all three valid values: console, json, slog - Update Logging section to mention --log_level and slog format - Add link to docs/USER_MANUAL.md in the docs section Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 0afdef5 commit e2ca5d7

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
Toolkit is a collection of reusable Go components exposed through a modular CLI and optional TUI (built with [Bubble Tea](https://github.com/charmbracelet/bubbletea)).
99
It targets day-to-day DevOps & development automation: querying Kubernetes, parsing Terraform plans, mass-editing config files, and inspecting large data tables directly in your terminal.
1010

11+
- [User Manual](docs/USER_MANUAL.md)
1112
- [Kubernetes Client Fakes & Testing Patterns](docs/guide/k8s-fake-patterns.md)
1213

1314
---
@@ -83,7 +84,8 @@ toolkit --help # all global flags
8384
| `--kubeconfig` | `~/.kube/config` | Path to kubeconfig file |
8485
| `--log_file` | `toolkit.log` | Path to log file |
8586
| `--debug` | `false` | Enable debug logging |
86-
| `--log_format` | `console` | Log format: console or json |
87+
| `--log_format` | `console` | Log format: `console`, `json`, or `slog` |
88+
| `--log_level` | | Minimum log level: `debug`, `info`, `warn`, `error` (empty uses `--debug` flag) |
8789

8890
*(See `internal/cli/root.go` for the authoritative list.)*
8991

@@ -183,7 +185,7 @@ Toolkit follows a modular, testable architecture:
183185

184186
## Logging
185187

186-
Toolkit uses [zap](https://github.com/uber-go/zap) for structured, machine-readable logging. By default logs are written to `toolkit.log` (configurable via `--log_file`) and support `--log_format` of `console` or `json`.
188+
Toolkit uses [zap](https://github.com/uber-go/zap) for structured, machine-readable logging. By default logs are written to `toolkit.log` (configurable via `--log_file`) and support `--log_format` of `console`, `json`, or `slog`. The minimum log level can be set via `--log_level` (`debug`, `info`, `warn`, `error`).
187189

188190
## Contributing
189191

0 commit comments

Comments
 (0)