docs(shotcut): clarify REPL vs one-shot auto-save#29
docs(shotcut): clarify REPL vs one-shot auto-save#29Jah-yee wants to merge 1 commit intoHKUDS:mainfrom
Conversation
Made-with: Cursor
|
Thanks for clarifying the REPL vs. one-shot behavior in the docs. Following up on the auto-save discussion: to me, an explicit In recent versions (24.01+), the Shotcut GUI has a "Backup and Save" feature that creates timestamped copies (e.g., Does the team have thoughts on aligning the CLI's persistence model with Shotcut's backup/autosave features rather than relying on explicit flags? |
|
I do agree with @jarrodcolburn 's opinion on the default behavior of auto-saving and dry-run. And yes, --no-save feels more like dry-run. Probably we typically only need: 1) default auto saving for one-line cmd, and 2) a must-have dry-run cmd |
Summary
Clarify the execution model for Shotcut's REPL vs one-shot usage in
shotcut/agent-harness/HARNESS.md, and document how the new-s/--saveflag affects auto-save behavior in one-shot mode.This addresses follow-up concerns raised in
#15 about user
expectations for persistence when not using the
replsubcommand.Background
In #15 we introduced the
-s/--saveflag and anauto_saveglobalflag so that one-shot commands can automatically persist changes to the
project file after each mutation command.
As @jarrodcolburn pointed out, if the
replsubcommand is not used,many users might reasonably expect that commands will save changes by
default, making an explicit
--saveflag feel redundant.@yuh-yang suggested addressing this more fundamentally via
HARNESS.md, which this PR does.Changes
no automatic saving.
only unless saved explicitly or via auto-save.
-s/--saveenables auto-save for one-shot commands,including a concrete before/after example with
timeline add-track.(e.g. flipping the default to auto-save with a
--no-saveoverride)if it proves to better match common usage patterns.
Rationale
This PR does not change any behavior introduced in #15. Instead, it:
HARNESS.md.default auto-save for one-shot with a
--no-saveopt-out).This should help set expectations for users running one-shot commands,
and directly addresses the concerns raised in the discussion on #15.