Skip to content

Explained level options with examples #369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
asmacdo wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Explained level options with examples #369

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02d0da3
explain level options with examples
asmacdo Jan 16, 2026
e094b3d
Add log level doc for CRITICAL level
asmacdo Jan 16, 2026
23fe39a
center level, left align description
asmacdo Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Try it out using either `duct` or `con-duct run`:

`duct` is most useful when the report-interval is less than the duration of the script.

## Command Reference
## Reference

### con-duct

Expand Down Expand Up @@ -239,6 +239,46 @@ options:
```
<!-- END HELP -->

### Log Levels

Control duct's verbosity with `--log-level` (or `DUCT_LOG_LEVEL` environment variable):

| Level | Use when... |
|-------|-------------|
Copy link
Contributor

@CodyCBakerPhD CodyCBakerPhD Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommendation: decide on alignment style

E.g.

Suggested change
|-------|-------------|
|:-------:|:-------------:|

aligns to center

Currently

Image

doesn't look quite as good as it 'could'

Up to you though

Copy link
Member Author

@asmacdo asmacdo Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

went with center for levels, left for the text. thanks!

| `NONE` | Running in scripts where you only want the command's output |
| `ERROR` | You want silence unless something fails |
| `WARNING` | You want to see potential issues but not routine info |
| `INFO` | Normal interactive use (default) |
| `DEBUG` | Troubleshooting duct behavior or unexpected results |

**INFO (default)** - Shows execution status and summary:
```
$ duct echo "hello world"
2026-01-16T12:01:52 [INFO ] con-duct: duct is executing 'echo hello world'...
2026-01-16T12:01:52 [INFO ] con-duct: Log files will be written to .duct/logs/2026.01.16T12.01.52-12345_
hello world
2026-01-16T12:01:52 [INFO ] con-duct: Summary:
Exit Code: 0
Command: echo hello world
...
```

**NONE** - Silent operation, only shows command output:
```
$ duct --log-level NONE echo "hello world"
hello world
```

**DEBUG** - Verbose output for troubleshooting:
```
$ duct --log-level DEBUG echo "hello world"
2026-01-16T12:02:02 [DEBUG ] con-duct: Searching for .env files in: /etc/duct/.env:...
2026-01-16T12:02:02 [DEBUG ] con-duct: .env file not found (skipping): .duct/.env
2026-01-16T12:02:02 [INFO ] con-duct: duct is executing 'echo hello world'...
2026-01-16T12:02:02 [DEBUG ] con-duct: Starting monitoring of the process...
...
```

## FAQs

### git-annex add keeps adding duct logs directly into git
Expand Down
Loading