archiver-ts 0.0.8 → 0.1.0

package/README.md

@@ -20,8 +20,6 @@ Archive / restore:
 arv put <items...> [-v|--vault <vault>] [-m|--message <msg>] [-r|--remark <remark>]
 arv restore <ids...>
 arv move <ids...> --to <vault>
-arv cd <archive-id | vault/archive-id> [--print]
-arv cd - [--print]
 ```
 
 Vault management:
@@ -38,43 +36,92 @@ arv vault list [-a|--all]
 Query and maintenance:
 
 ```bash
-arv list [--restored] [--all] [--vault <vault>] [--no-interactive]
+arv list [--restored] [--all] [--vault <vault>] [--no-interactive] [--plain]
 arv log [YYYYMM | YYYYMM-YYYYMM | all]
 arv log --id <log-id>
 arv config list [-c|--comment]
 arv config alias <alias=path> [-r|--remove]
 arv config update-check <on|off>
 arv config vault-item-sep <separator>
+arv config style <on|off>
+arv config language <zh|en>
+arv config no-command-action <help|list|unknown>
 arv update [--repo <owner/repo>] [--install]
 arv check
 ```
 
+`arv log` without range now prints all records by default (grep-friendly).
+
 ## List output behavior
 
-`arv list` plain mode prints one entry per line:
+`arv list` default non-interactive output is one line per entry:
 
 - format: `[<archiveId>] <A|R> <display-name>`
+- `<archiveId>` is zero-padded to 4 digits
 - default vault (`@`, id `0`): `<display-name>` is item name only
 - non-default vault: `<display-name>` is `<vaultName>(<vaultId>)<sep><item>`
 - `<sep>` comes from `config vault-item-sep` (default `::`)
 
-Example:
+Use `arv list --plain` for grep/script usage:
+
+- format: `<archiveId><TAB><A|R><TAB><display-name>`
+- always disables interactive picker
+- prints no extra hints/messages when no entries match
+
+Examples:
 
 ```text
 [0001] A todo.txt
 [0002] A work(1)::report.pdf
+1	A	todo.txt
+2	A	work(1)::report.pdf
 ```
 
 ## Shell wrapper note
 
-On interactive terminal startup, `arv` may auto-install a shell wrapper function so `cd` can move your shell to archive slot paths.
+On interactive terminal startup, `arv` may auto-install a shell wrapper function so `arv list` interactive `Enter slot` can move your shell to archive slot paths.
+
+Use project-prefixed env overrides when needed:
+
+```bash
+ARCHIVER_DISABLE_SHELL_INIT=1 arv <command>
+ARCHIVER_STYLE=off arv list
+```
+
+## No-command behavior
+
+When you run `arv` without any subcommand, behavior is controlled by config:
 
-Disable this behavior if needed:
+- `unknown` (default): ask once (list/help) and save to config
+- `help`: show help text
+- `list`: run `arv list`
+
+If `no_command_action` is `unknown` and input is not TTY (e.g. piped/CI), `arv` falls back to help text for that run.
+
+Set it with:
 
 ```bash
-ARV_DISABLE_SHELL_INIT=1 arv <command>
+arv config no-command-action unknown
+arv config no-command-action help
+arv config no-command-action list
 ```
 
+## Language
+
+- default language is `zh`
+- switch language with:
+
+```bash
+arv config language zh
+arv config language en
+```
+
+## JSONC defaults and comments
+
+- `config.jsonc` and `auto-incr.jsonc` are initialized from `public/config.default.jsonc` and `public/auto-incr.default.jsonc`.
+- Build keeps these default JSONC files and copies them into `dist/` as-is.
+- Saving config/auto-incr updates values while preserving existing JSONC comments.
+
 ## Useful aliases
 
 - `list`: `l`, `ls`

package/dist/auto-incr.default.jsonc

@@ -0,0 +1,7 @@
+// 各个实体的自增 ID，存储于此
+// This file stores the auto-incrementing IDs for various entities.
+{
+  "logId": 0,
+  "vaultId": 0,
+  "archiveId": 0,
+}

package/dist/config.default.jsonc

@@ -0,0 +1,31 @@
+{
+  // 当前使用的 vault ID，默认为 0，表示默认 vault
+  // The currently active vault ID, default is 0 which represents the default vault
+  "currentVaultId": 0,
+
+  // 是否检查更新，默认为 "on"
+  // Whether to check for updates, default is "on"
+  "updateCheck": "on", // "on" | "off"
+
+  // 记录上一次检查更新的时间
+  // Records the last time updates were checked
+  "lastUpdateCheck": "",
+
+  "aliasMap": {},
+
+  // 开启后，控制台会输出彩色的、有样式的文字，更美观
+  // When turned on, the console will output colorful and styled text for better aesthetics
+  "style": "on", // "on" | "off"
+
+  // 语言设置，默认中文
+  // UI language, default is Chinese
+  "language": "zh", // "zh" | "en"
+
+  // 在arv list 命令下，vault 中条目的分隔符，默认为 "::"
+  // The separator for items in the vault, default is "::"
+  "vaultItemSeparator": "::",
+
+  // 配置只输入arv，没有子命令的时候的行为
+  // Configures the behavior when only "arv" is entered without a subcommand
+  "noCommandAction": "unknown", // "unknown" | "help" | "list"
+}