Skip to content

docs(readme): hotdata.dev/install, update check, sorted indexes, env vars - #351

Merged
eddietejeda merged 1 commit into
mainfrom
readme-refresh
Oct 18, 2026
Merged

eddietejeda merged 1 commit into
mainfrom
readme-refresh

Conversation

@eddietejeda

Copy link
Copy Markdown
Contributor

README audit against the 0.43.0 binary. The command table already matched all 83 commands; the rest is what had drifted:

  • Install: single command curl -fsSL https://hotdata.dev/install | sh (verified end to end on macOS after hotdata-dev/www#456 deployed).
  • Interactive new-release check and HOTDATA_NO_UPDATE_CHECK.
  • --type sorted in the Search section.
  • Env vars that were read by the CLI but not documented: HOTDATA_DATABASE, HOTDATA_NO_UPDATE_CHECK, HOTDATA_CONFIG_DIR, HOTDATA_UPLOAD_CONCURRENCY.

Docs-only; no skill change needed (README edits count toward the drift check, so the next release's skill-drift gate may ask for SKIP_SKILL_DRIFT=1 if nothing else lands).

…vars

- Install command is now the vanity URL (live since www#456).
- Mention the interactive new-release check and HOTDATA_NO_UPDATE_CHECK.
- Search section names the sorted index type.
- Configuration table gains HOTDATA_DATABASE, HOTDATA_NO_UPDATE_CHECK,
  HOTDATA_CONFIG_DIR, HOTDATA_UPLOAD_CONCURRENCY.
@eddietejeda
eddietejeda requested a review from a team as a code owner October 18, 2026 02:27
@eddietejeda
eddietejeda requested review from rohan-hotdata and removed request for a team October 18, 2026 02:27
@eddietejeda
eddietejeda enabled auto-merge (squash) October 18, 2026 02:27
Comment thread README.md
Comment on lines +32 to +34
Stay current with `hotdata manage upgrade`: in an interactive terminal the CLI
checks for a new release before API commands and offers to upgrade (set
`HOTDATA_NO_UPDATE_CHECK=1` to skip). Enable tab completion with

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: State that declining the upgrade blocks the command (not blocking).

enforce_latest_or_exit in src/commands/update.rs:176-181 exits with status 1 on decline. A successful upgrade also exits and asks the user to re-run. "Offers to upgrade" reads as optional, so a user expects the command to continue after "n".

Suggested change
Stay current with `hotdata manage upgrade`: in an interactive terminal the CLI
checks for a new release before API commands and offers to upgrade (set
`HOTDATA_NO_UPDATE_CHECK=1` to skip). Enable tab completion with
Stay current with `hotdata manage upgrade`: in an interactive terminal the CLI
checks for a new release before API commands and requires the upgrade before
continuing (set `HOTDATA_NO_UPDATE_CHECK=1` to skip, e.g. offline). Enable tab completion with

@eddietejeda
eddietejeda merged commit 1ec1832 into main Oct 18, 2026
14 checks passed
@eddietejeda
eddietejeda deleted the readme-refresh branch October 18, 2026 02:28
@codecov

codecov Bot commented Oct 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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