docs(sandbox): explain in --help why every unit of work needs a checkpoint - #632
Merged
Merged
Conversation
…point Sandbox writes are committed but not checkpointed, so they never appear in the builder's version history. A Restore or Revert there rolls the app back to the last checkpoint and discards everything written after it. Over the last 7 days ~44% of CLI write/edit calls were never followed by a checkpoint. Add one shared note to the help of `sandbox`, `sandbox write`, `sandbox edit`, and `sandbox run`, expand `sandbox checkpoint --help` with the same explanation, and align the command description and README row. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018KF965sjvZemY14NvcYd5w
Contributor
🚀 Package Preview Available!Install this PR's preview build with npm: npm i @base44-preview/cli@0.1.15-pr.632.1a53729Prefer not to change any import paths? Install using npm alias so your code still imports npm i "base44@npm:@base44-preview/cli@0.1.15-pr.632.1a53729"Or add it to your {
"dependencies": {
"base44": "npm:@base44-preview/cli@0.1.15-pr.632.1a53729"
}
}
Preview published to npm registry — try new features instantly! |
netanelgilad
approved these changes
Sep 22, 2026
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
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.
Note
Description
Sandbox writes are committed to the app but do not create an entry in the builder's version history — so a Restore or Revert in the builder rolls the app back to the last checkpoint and silently discards everything written after it. This PR makes that contract explicit in
--helpoutput, so agents and users drivingbase44 sandboxknow to runbase44 sandbox checkpointafter each unit of work and before stopping. Documentation only: no runtime behavior changes.Related Issue
None
Type of Change
Changes Made
CHECKPOINT_HELPconstant inpackages/cli/src/cli/commands/sandbox/shared.tsso the warning is written once and reused.--helpfor thesandboxparent command and forsandbox write,sandbox edit, andsandbox run(the run text adds "A command that changes files needs a checkpoint too.").sandbox checkpoint's help: the description is now "Save a restore point in the builder's version history (run after each unit of work)", with a longeraddHelpTextblock explaining why, plus a note that pending changes are flushed first so the checkpoint captures the latest code.--namefrom "Optional message/title for the checkpoint" to steer toward a short summary of what changed.sandbox checkpointrow inpackages/cli/README.mdand added aCHANGELOG.mdentry under Changed.Testing
npm test)Checklist
docs/(AGENTS.md) if I made architectural changesAdditional Notes
No tests were added or changed — the diff only touches help strings, and the existing
packages/cli/tests/cli/sandbox.spec.tsasserts on command behavior rather than help text, so nothing there needed updating. Typecheck and lint were not run in this environment (those commands required approval); both are expected to be unaffected since the only source change is one new exported string constant and its call sites. Thedocs/checkbox is unchecked because this is a help-text change, not an architectural one.🤖 Generated by Claude | 2026-09-22 06:57 UTC | 1a53729