From b013e5fb87580e4cab0d85a0d2c8bb402c610413 Mon Sep 17 00:00:00 2001 From: Lukasz Kasprzak Date: Mon, 14 Sep 2026 22:42:52 +0200 Subject: plan 10: docs (-n, README version and scope, trash identity, --json U+FFFD, limitations, changelog) --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 64c8a72..c453726 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ file's type, name, path, size, age, text content or duplicate status, combined with `and` / `or` / `not`, that trigger actions — copy, move, rename, delete (to the Trash by default), chained in the order written. It shows the plan before touching anything, lets you approve all of it or file -by file, logs every step, and can undo a run. Version 0.0.1 is the engine +by file, logs every step, and can undo a run. Version 0.0.7 is the engine and this command-line interface: per-directory rule files, placeholders in -destinations and new names, and builds for Linux, FreeBSD and OpenBSD. It is -not a GUI (that comes later), a watch mode, OCR, EXIF dates, macOS or -Windows support, a content cache, a shell-command action, or a way to look -inside archives. +destinations and new names, a keyword cache that makes a rerun fast, and +builds for Linux, FreeBSD and OpenBSD. It is not a GUI (that comes later), a +watch mode, OCR, EXIF dates, macOS or Windows support, a shell-command +action, or a way to look inside archives. ## Install @@ -94,7 +94,7 @@ EOF ``` This one rule matches any file whose name contains "acme" and moves it into -`Filed/Acme`. See what it would do, without changing anything: +`Filed/Acme`. See what it would do, without moving anything: ``` $ krino -n demo @@ -216,14 +216,15 @@ rule content only when a private pattern list is configured with gone, changed, or the original path is occupied again) is refused for that file rather than guessed at. - `-n` prints the plan and changes none of your files — no config is - written, nothing is moved, nothing is logged. It may refresh the keyword - cache in `~/.cache/krino`, which only makes the next run faster. + written, nothing is moved, nothing is logged. It may create krino's empty + state directory and refresh the keyword cache in `~/.cache/krino`, which + only makes the next run faster. ## Status -**0.0.1, local only.** The module path is `krino`; `go install -krino@v0.0.1` only works once a remote is chosen and the imports are -renamed to match (`docs/design.md`, §18). Until then, build from a clone. +**0.0.7, local only.** The module path is `krino`; `go install` only +works once a remote is chosen and the imports are renamed to match +(`docs/design.md`, §18). Until then, build from a clone. `krino -n --json`'s output shape is unstable before krino 1.0 — don't script against it yet. -- cgit v1.3