Skip to content

Update README for v0.0.31, and unbreak the --no-file-storage help text - #62

Merged
giordano-lucas merged 1 commit into
mainfrom
docs/readme-v0.0.31
Aug 6, 2026
Merged

Update README for v0.0.31, and unbreak the --no-file-storage help text#62
giordano-lucas merged 1 commit into
mainfrom
docs/readme-v0.0.31

Conversation

@giordano-lucas

Copy link
Copy Markdown
Member

The README still described the pre-v0.0.31 flag surface — it showed --solve-captchas and --use-file-storage as things you switch on, when all three of those options default to true server-side, and it didn't mention the new flags at all.

README said Now
--headless (a no-op against the default) --headed
--solve-captchas --no-solve-captchas
--use-file-storage --no-file-storage

Also fixed

Session lifetime is now documented. #60 surfaced defaults of 3 minutes idle / 15 minutes total; neither appeared in the README. Both are short enough that a long task outlives them, and the next command then fails with a bare Session closed that doesn't say why.

notte page upload was documented wrong. The README showed a positional notte page upload <id> <file>. It's a required --file flag, and the name refers to a file in the uploads store, not a path on the caller's machine — a local path fails with Unable to get file: <path> for upload. The notte files upload step it needs first is now spelled out, along with the matching notte files download --from session for retrieving what page download produces.

Dropped no-op flags from examples that only passed --headless / --solve-captchas to get the default behaviour.

A cosmetic bug I shipped in #61

Cobra's UnquoteUsage treats the first backquoted span in a usage string as the flag's value placeholder. My --no-file-storage description had `notte page download` in backticks, so v0.0.31 renders it as:

--no-file-storage notte page download   Do not attach FileStorage...

— as though the flag took an argument named "notte page download". Single quotes instead:

--no-file-storage                       Do not attach FileStorage. Disables 'notte page download' and ...

Verification

  • Every flag in the README checked against notte sessions start --help on v0.0.31
  • --headed, --no-solve-captchas, --no-file-storage each exercised against the API: headless: false, solve_captchas: false, use_file_storage: false
  • Defaults confirmed live: idle_timeout_minutes: 3, max_duration_minutes: 15
  • golangci-lint 0 issues; go test ./internal/... all 10 packages pass

🤖 Generated with Claude Code

The README still described the pre-v0.0.31 flag surface. It showed
--solve-captchas and --use-file-storage as things you switch on, when all three
of those options default to true server-side, and it did not mention --headed,
--no-solve-captchas or --no-file-storage at all.

  --headed                    # was: --headless (a no-op against the default)
  --no-solve-captchas         # was: --solve-captchas
  --no-file-storage           # was: --use-file-storage

Also:

- document the session lifetime that #60 surfaced: 3 minutes idle, 15 minutes
  total. Neither default appeared in the README, and both are short enough that
  the next command fails with a bare "Session closed" without saying why
- drop --headless and --solve-captchas from examples that only passed them to
  get the default behaviour
- correct `notte page upload`. The README showed a positional
  `notte page upload <id> <file>`; it is a required --file flag, and the name
  refers to a file in the uploads store rather than a path on the caller's
  machine, so a local path fails with "Unable to get file: <path> for upload".
  The `notte files upload` step it needs first is now spelled out, as is the
  matching `notte files download --from session` for retrieving what
  `page download` produced

Separately, fixes a cosmetic bug I shipped in #61. Cobra's UnquoteUsage takes
the first backquoted span in a usage string as the flag's value placeholder, and
the --no-file-storage description had `notte page download` in backticks, so
v0.0.31 renders it as:

  --no-file-storage notte page download   Do not attach FileStorage...

as though the flag took an argument. Single quotes instead.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@giordano-lucas
giordano-lucas merged commit 5173e54 into main Aug 6, 2026
4 checks passed
@greptile-apps

greptile-apps Bot commented Aug 6, 2026

Copy link
Copy Markdown

Greptile Summary

Updates the README to match the current session opt-out flags, timeout defaults, and file upload/download workflows, and fixes Cobra’s rendering of the --no-file-storage help text.

  • Replaces obsolete or no-op session flags in examples.
  • Documents session lifetime defaults and file-store workflows.
  • Uses literal single quotes to prevent Cobra from treating command names as a flag value placeholder.

Confidence Score: 4/5

The PR appears safe to merge, with a non-blocking need for regression coverage of the corrected Cobra help output.

The documentation and usage-string changes align with the current CLI contracts, but no test protects the specific help-rendering behavior fixed by this change.

Files Needing Attention: internal/cmd/sessionstart_optout.go

Important Files Changed

Filename Overview
README.md Documentation now reflects the current session defaults, opt-out flags, and upload/download command syntax; no concrete correctness issue found.
internal/cmd/sessionstart_optout.go The help-text quoting fix is appropriate, but the corrected rendered signature lacks regression-test coverage required by repository guidelines.

Fix All in Claude Code

Prompt To Fix All With AI
### Issue 1
internal/cmd/sessionstart_optout.go:80
**Help regression lacks coverage**

This user-visible Cobra help fix has no test asserting that `--no-file-storage` renders without a value placeholder, so the malformed signature can be reintroduced without the test suite detecting it.
- Add a comment if the PR does n... ([source](https://app.greptile.com/review/custom-context?memory=instruction-0))

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs: update README for v0.0.31, and unb..." | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant