docs: improved fs_patch and fs_write descriptions and examples

This commit is contained in:
2026-06-03 12:06:39 -06:00
parent 43fbe448cb
commit b781dd8dc6
3 changed files with 10 additions and 4 deletions
+4 -2
View File
@@ -1,8 +1,10 @@
#!/usr/bin/env bash
set -e
# @describe Apply a patch to a file at the specified path.
# This can be used to edit a file without having to rewrite the whole file.
# @describe Apply a unified-diff patch to a file at the specified path. Use this for editing an existing file. It's the
# PREFERRED way to modify a file. Prefer this over fs_write whenever the file already exists: it sends less data,
# preserves unchanged content automatically, and is less prone to accidental data loss from full rewrites.
# Use fs_write only when you are creating a new file or doing a complete rewrite where most of the content changes.
# @option --path! The path of the file to apply the patch to
# @option --contents! The patch to apply to the file
+3 -1
View File
@@ -1,7 +1,9 @@
#!/usr/bin/env bash
set -e
# @describe Write the full file contents to a file at the specified path.
# @describe Write the FULL file contents to a file at the specified path. Use this for NEW files or COMPLETE rewrites
# only. For editing an existing file, prefer fs_patch. It's a surgical edit that preserves unchanged content, requires
# sending less data, and is less prone to accidental data loss.
# @option --path! The path of the file to write to
# @option --contents! The full contents to write to the file