forked from cleveragents/cleveragents-core
Docs: Updated the details around the verbosity flag and added some related config items
This commit is contained in:
+15
-9
@@ -240,7 +240,7 @@ Configure global state locations and shell integration for every command.
|
||||
- `--version`: Print the version and exit.
|
||||
- `--install-completion [SHELL]`: Install shell completion for the given shell.
|
||||
- `--show-completion [SHELL]`: Show the completion script for the given shell.
|
||||
- `-v`: Increase log verbosity for a single invocation (repeatable). Each additional `-v` raises the logging level one notch above the configured default. No `-v` uses the default level (typically WARNING for terminal output). `-v` = INFO, `-vv` = DEBUG, `-vvv` = TRACE, `-vvvv` = the most granular logging level available. This flag does not persist — it only affects the current invocation.
|
||||
- `-v`: Increase log verbosity for a single invocation (repeatable). By default (no `-v`), only normal command output is shown on stdout; logging output is suppressed except on fatal errors where the application exits entirely and displays the error. Each additional `-v` raises the verbosity one level: `-v` = ERROR (non-fatal, recoverable errors), `-vv` = WARN (warnings that may indicate a degraded system but are not necessarily errors), `-vvv` = INFO (routine informative messages useful to common users), `-vvvv` = DEBUG (coarse debugging output), `-vvvvv` = TRACE (the most granular logging level available). Increased verbosity writes to both the log file and stderr by default, keeping log output separate from normal program output on stdout. The destination for log output raised by `-v` is configurable: it can be sent to the terminal (stderr by default, or redirected to another stream such as stdin or a device), to the log file only, or to both. See `core.log.terminal`, `core.log.terminal-stream`, and `core.log.file-enabled` configuration keys for details. This flag does not persist — it only affects the current invocation.
|
||||
|
||||
**Examples**
|
||||
|
||||
@@ -1475,7 +1475,7 @@ Run a named actor in isolation with simple, manual context.
|
||||
- `<NAME>`: The name of the actor to run (required).
|
||||
- `<PROMPT>`: Prompt text (positional argument).
|
||||
- `--output/-o FILE`: Output file path.
|
||||
- `--verbose/-v`: Increase verbosity (repeatable).
|
||||
- `--verbose/-v`: Increase log verbosity (repeatable). Same semantics as the global `-v` flag: no `-v` = normal output only, `-v` = ERROR, `-vv` = WARN, `-vvv` = INFO, `-vvvv` = DEBUG, `-vvvvv` = TRACE.
|
||||
- `--unsafe/-u`: Allow unsafe configs.
|
||||
- `--context NAME`: Named actor context to attach.
|
||||
- `--context-dir PATH`: Context storage location.
|
||||
@@ -4849,7 +4849,7 @@ None.
|
||||
│ <span style="opacity: 0.7;">──────────────── ────────────────── ─────── ────────</span> │
|
||||
│ core.automation-profile trusted config yes │
|
||||
│ actor.default.invariant local/reconciler config yes │
|
||||
│ core.log.level INFO default no │
|
||||
│ core.log.level FATAL default no │
|
||||
╰────────────────────────────────────────────────────────────╯
|
||||
|
||||
╭─ Overrides ─────╮
|
||||
@@ -13443,8 +13443,11 @@ Keys are organized by their top-level group. Within each group, the full dot-pat
|
||||
| `core.format` | string | `rich` | `CLEVERAGENTS_FORMAT` | Default output rendering format for all CLI commands. Accepted values: `rich`, `color`, `table`, `plain`, `json`, `yaml`. Overridden per-invocation by the `--format` CLI flag. |
|
||||
| `core.namespace` | string | `local` | `CLEVERAGENTS_NAMESPACE` | The default namespace prefix applied when creating entities without an explicit namespace. For local-only usage, this is `local`. In server mode, typically the user's username or organization name. |
|
||||
| `core.automation-profile` | string | `supervised` | `CLEVERAGENTS_AUTOMATION_PROFILE` | The default automation profile applied to new plans when no profile is specified at the plan, action, or project level. Accepts any built-in profile name (`manual`, `review`, `supervised`, `cautious`, `trusted`, `auto`, `ci`, `full-auto`) or a custom profile name in `<namespace>/<name>` format. **Project-scopable.** |
|
||||
| `core.log.level` | string | `INFO` | `CLEVERAGENTS_LOG_LEVEL` | Global logging verbosity. Accepted values: `DEBUG`, `INFO`, `WARNING`, `ERROR`. Controls log output written to the log directory. The `-v` CLI flag can be repeated (`-v`, `-vv`, `-vvv`, `-vvvv`) to increase verbosity incrementally for a single invocation. |
|
||||
| `core.log.dir` | string | `<core.data-dir>/logs` | `CLEVERAGENTS_LOG_DIR` | Directory where log files are written. |
|
||||
| `core.log.level` | string | `FATAL` | `CLEVERAGENTS_LOG_LEVEL` | Base logging verbosity level. Accepted values (from least to most verbose): `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`. The default `FATAL` means only fatal errors (where the application exits) produce log output; all other log messages are suppressed. The `-v` CLI flag can be repeated (`-v` through `-vvvvv`) to raise the effective level for a single invocation: `-v` = ERROR, `-vv` = WARN, `-vvv` = INFO, `-vvvv` = DEBUG, `-vvvvv` = TRACE. The effective level applies to both log file output and terminal log output (subject to `core.log.terminal` and `core.log.file-enabled` settings). |
|
||||
| `core.log.dir` | string | `<core.data-dir>/logs` | `CLEVERAGENTS_LOG_DIR` | Directory where log files are written. Can be set to an alternative path to redirect log storage. |
|
||||
| `core.log.file-enabled` | boolean | `true` | `CLEVERAGENTS_LOG_FILE_ENABLED` | Whether log output is written to log files. When `true`, log messages at or above the effective verbosity level are written to the log directory. When `false`, log file output is suppressed entirely (useful when log output should only go to the terminal). |
|
||||
| `core.log.terminal` | string | `auto` | `CLEVERAGENTS_LOG_TERMINAL` | Controls whether log output raised by `-v` is also displayed on the terminal. Accepted values: `auto` (show on terminal when `-v` is used, suppress otherwise), `always` (always show log output on terminal at the effective level), `never` (suppress terminal log output entirely — log only to file). This keeps log output separate from normal program output, which goes to stdout. |
|
||||
| `core.log.terminal-stream` | string | `stderr` | `CLEVERAGENTS_LOG_TERMINAL_STREAM` | The stream used for terminal log output. Accepted values: `stderr` (default, keeps logs separate from normal stdout output), `stdout` (merge with normal output), or a file path / device path (e.g., `/dev/null`, `/dev/pts/1`, or a file path) to redirect terminal log output to an alternative destination. |
|
||||
| `core.log.retention-days` | integer | `30` | `CLEVERAGENTS_LOG_RETENTION_DAYS` | Number of days to retain log files before automatic cleanup. |
|
||||
| `core.backup.dir` | string | `<core.data-dir>/backups` | `CLEVERAGENTS_BACKUP_DIR` | Directory where backup snapshots are stored. |
|
||||
| `core.backup.retention-days` | integer | `7` | `CLEVERAGENTS_BACKUP_RETENTION_DAYS` | Number of days to retain backup snapshots created during project deletion, `agents init` resets, and plan correction history cleanup. Backups older than this are automatically purged. |
|
||||
@@ -13600,7 +13603,10 @@ The global configuration file uses TOML format. The hierarchical key structure m
|
||||
<span style="color: cyan;">automation-profile</span> = <span style="color: #66cc66;">"supervised"</span>
|
||||
|
||||
[<span style="color: cyan; font-weight: 600;">core.log</span>]
|
||||
<span style="color: cyan;">level</span> = <span style="color: #66cc66;">"INFO"</span>
|
||||
<span style="color: cyan;">level</span> = <span style="color: #66cc66;">"FATAL"</span>
|
||||
<span style="color: cyan;">terminal</span> = <span style="color: #66cc66;">"auto"</span>
|
||||
<span style="color: cyan;">terminal-stream</span> = <span style="color: #66cc66;">"stderr"</span>
|
||||
<span style="color: cyan;">file-enabled</span> = <span style="color: yellow;">true</span>
|
||||
<span style="color: cyan;">retention-days</span> = <span style="color: yellow;">30</span>
|
||||
|
||||
[<span style="color: cyan; font-weight: 600;">core.backup</span>]
|
||||
@@ -20934,12 +20940,12 @@ The system analyzes the codebase using the code intelligence indexes (full-text,
|
||||
|
||||
<span style="color: #66cc66; font-weight: 600;">✓ OK</span> Config updated
|
||||
|
||||
<span style="color: #66cc66; font-weight: 600;">$</span> <span style="color: cyan; font-weight: 600;">agents</span> config set core.log.level WARNING
|
||||
<span style="color: #66cc66; font-weight: 600;">$</span> <span style="color: cyan; font-weight: 600;">agents</span> config set core.log.level WARN
|
||||
|
||||
╭─ Config Updated ──────────────────╮
|
||||
│ <span style="color: cyan; font-weight: 600;">Key:</span> core.log.level │
|
||||
│ <span style="color: #66cc66; font-weight: 600;">Value:</span> WARNING │
|
||||
│ <span style="color: yellow; font-weight: 600;">Previous:</span> INFO │
|
||||
│ <span style="color: #66cc66; font-weight: 600;">Value:</span> WARN │
|
||||
│ <span style="color: yellow; font-weight: 600;">Previous:</span> FATAL │
|
||||
│ <span style="color: #5599ff; font-weight: 600;">Source:</span> config │
|
||||
│ <span style="color: yellow; font-weight: 600;">Scope:</span> global │
|
||||
╰───────────────────────────────────╯
|
||||
|
||||
Reference in New Issue
Block a user