跳转到内容

命令参考

直接执行 sharge 会打印根文本 help 并返回 0。执行 sharge --help --json 返回完整机器命令目录。未知命令返回 INVALID_COMMAND 和退出码 2

全局 options

Option说明
--help文本 help,不登录、不联网
--json输出稳定 JSON envelope
--jq <expression>过滤完整 success envelope,要求 --json
--debug将终端诊断写入 stderr
--timeout <duration>总超时,必须带 sm
--timezone <iana>本次调用使用的 IANA timezone

写命令还会按需提供:

Option说明
`—input <json@file
--generate-input离线输出可编辑 JSON 模板
--dry-run零网络输出执行计划
--yes确认破坏性操作

下载命令提供:

Option说明
--file <path>明确保存路径
--overwrite覆盖明确路径
--dry-run零网络检查下载计划

不存在:

  • --api-key
  • --base-url
  • --output
  • --retry
  • --all / --page-all
  • --params
  • --fields
  • --non-interactive

根命令

产品命令

  • Notes
    • list
    • search
    • get
    • update
    • delete
    • download
  • Calendar
    • month
    • list
    • search
    • get
    • create
    • update
    • delete
    • todos set-status
  • Recordings
    • list
    • search
    • get
    • download
  • Diary
    • list
    • search
    • get

Scope 对照

NamespaceReadWrite
Notesquick_notes:readquick_notes:write
Calendarcalendar:readcalendar:write
Recordingsvoicemaster:read不支持
Diaryai_daily:read不支持

网络与重复执行

  • 普通读命令发送一次业务请求。
  • 列表命令一次只读取一页。
  • 写命令发送一次业务请求。
  • CLI 不自动重试。
  • download 可能包含 Open Platform 请求和服务端 redirect。
  • login 包含创建会话、状态检查和协议轮询。
  • help、version、config、logs path、输入模板和 dry run 可以完全离线执行。

每个具体命令的 JSON help 是最终机器契约:

Terminal window
sharge <namespace> <command> --help --json