docs(cli): document cora upgrade — self-upgrade was undocumented - #549
Merged
Conversation
Add a Self-Upgrade section to docs/cli-reference.md (--check, default flow with SHA-256 checksum verification, -y for CI), a README install/ upgrade note and a command-table row, per #541. Correction vs the issue body: the background update check is disabled via the CORA_NO_UPDATE_CHECK=1 environment variable — no --no-update-check flag exists. Closes #541
This was referenced Aug 31, 2026
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Closes #541:
cora upgradeis implemented and wired but absent from the docs.docs/cli-reference.md: new Self-Upgrade section —cora upgrade --check, the default flow (OS/arch detection → latest GitHub release asset → SHA-256 checksum verification → binary replacement), andcora upgrade -yfor CI/automation.~/.codecora/cora-code/update-cache.json, stderr-only) and the cargo-from-source caveat.README.md: upgrade note under the install methods + a row in the command table.Why
Self-upgrade is a user-facing command with zero documentation: users have no discoverable way to update cora, and the startup update notification references behavior that is documented nowhere. This adds the missing reference so the command and its safety properties (checksum verification) are discoverable.
Correction vs the issue body
The issue proposed documenting a
--no-update-checkflag — that flag does not exist. The background check is disabled via theCORA_NO_UPDATE_CHECK=1environment variable (main.rs), so the docs document the env var.Testing
Docs-only change; no code paths touched.