sneak/sfdupes
1
0 Fork 0
Code Issues 5 Pull Requests 1 Actions 16 Packages Projects Releases Wiki Activity

proposal: say in --help where the database is and what each report prints #177

New Issue
Closed
opened 2026-11-11 01:06:05 +01:00 by clawbot · 3 comments
clawbot commented 2026-11-11 01:06:05 +01:00
Collaborator
Copy link
Copy source

Proposal from the acceptance test (#164). It needs your decision before anyone builds it.

What is missing

The help text does not say where the data goes or what the reports print. A user who installed the binary with go install has no README at hand, and --help is all there is.

  • No help text names the database: not /var/lib/sfdupes/db.sqlite, not SFDUPES_DATABASE, not that the default path needs root.
  • The help of report, trees, info and dwim is one sentence each. Nothing names the columns, says that the report is tab-separated text on stdout, or says that paths are escaped.
  • The help of dwim does not say that it wants root.

Example, all of sfdupes report --help:

Read the scan database and print the file-level duplicates report

Usage:
  sfdupes report [flags]

Flags:
  -h, --help   help for report

Why a user expects it

--help is the first thing a new user types. After sfdupes scan --help they still cannot tell where the scan was stored or how to choose another place.

What it would take

Text only, no change in behaviour:

  • sfdupes --help: two lines on the database, its default path and SFDUPES_DATABASE.
  • report --help and trees --help: the columns, the order of the rows, and the four escapes.
  • info --help: what it prints.
  • dwim --help: that it scans /, wants root, and stores the scan in the database.
  • One sentence in README.md under "Settings", which today describes only the help of scan.

Your choices

  • Fuller help text: build the above.
  • Leave as is: the README stays the only place that explains the database and the report columns.

Recommended: Fuller help text.

Model: fable-5-2

Proposal from the acceptance test (https://git.eeqj.de/sneak/sfdupes/issues/164). It needs your decision before anyone builds it. ## What is missing The help text does not say where the data goes or what the reports print. A user who installed the binary with `go install` has no README at hand, and `--help` is all there is. - No help text names the database: not `/var/lib/sfdupes/db.sqlite`, not `SFDUPES_DATABASE`, not that the default path needs root. - The help of `report`, `trees`, `info` and `dwim` is one sentence each. Nothing names the columns, says that the report is tab-separated text on stdout, or says that paths are escaped. - The help of `dwim` does not say that it wants root. Example, all of `sfdupes report --help`: ``` Read the scan database and print the file-level duplicates report Usage: sfdupes report [flags] Flags: -h, --help help for report ``` ## Why a user expects it `--help` is the first thing a new user types. After `sfdupes scan --help` they still cannot tell where the scan was stored or how to choose another place. ## What it would take Text only, no change in behaviour: - `sfdupes --help`: two lines on the database, its default path and `SFDUPES_DATABASE`. - `report --help` and `trees --help`: the columns, the order of the rows, and the four escapes. - `info --help`: what it prints. - `dwim --help`: that it scans `/`, wants root, and stores the scan in the database. - One sentence in `README.md` under "Settings", which today describes only the help of `scan`. ## Your choices - **Fuller help text**: build the above. - **Leave as is**: the README stays the only place that explains the database and the report columns. Recommended: **Fuller help text**. Model: fable-5-2
sneak was assigned by clawbot 2026-11-11 01:06:05 +01:00
sneak commented 2026-11-11 03:18:16 +01:00
Owner
Copy link
Copy source

rec approved

rec approved
clawbot commented 2026-11-11 03:24:01 +01:00
Author
Collaborator
Copy link
Copy source

sneak approved the recommendation above (chat via tracker, 11 November about 02:20 UTC); it is the definition of done, built as one PR into next with tests and README changes.

Model: opus-5-5

sneak approved the recommendation above (chat via tracker, 11 November about 02:20 UTC); it is the definition of done, built as one PR into `next` with tests and README changes. Model: opus-5-5
sneak was unassigned by clawbot 2026-11-11 03:24:01 +01:00
clawbot commented 2026-11-11 04:57:56 +01:00
Author
Collaborator
Copy link
Copy source

Built in #189. The top-level help and scan --help name the database. The help of report, trees, info and dwim says what each prints. The README's "Settings" section says the same.

Model: opus-5-5

Built in https://git.eeqj.de/sneak/sfdupes/pulls/189. The top-level help and `scan --help` name the database. The help of `report`, `trees`, `info` and `dwim` says what each prints. The README's "Settings" section says the same. Model: opus-5-5
Sign in to join this conversation.
No Branch/Tag Specified
Labels
Clear labels
critical
Extremely important: data loss, a security hole, production down, or basic use impossible
 merge-ready
Review passed; ready to merge
 needs-checks
CI checks failing or not yet green
 needs-decision
needs-decision
Waits on a decision only sneak can make
 needs-decision
Waits on a decision before work continues
 needs-rebase
Branch conflicts with main; rebase required
 needs-review
PR awaiting independent adversarial review
 needs-rework
Review found blocking problems; author must rework
 post-1.0
postponed by sneak until after 1.0
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
clawbot sneak (Jeffrey Paul)
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/sfdupes#177