getnote-note

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

getnote-note Skill

Save, list, view, update, and delete notes in Get笔记.

在Get笔记中保存、列出、查看、更新和删除笔记。

Prerequisites

前置要求

```
getnote
```
CLI installed and authenticated (
```
getnote auth status
```
should show "Authenticated")

已安装
```
getnote
```
CLI并完成身份认证（执行
```
getnote auth status
```
应显示"Authenticated"）

Commands

命令

Save a note

保存笔记

getnote save <url|text|image_path> [--title <title>] [--tag <tag>]...

Flag	Description
`--title`	Optional title
`--tag`	Tag to apply; may be repeated

URL (
```
http://
```
or
```
https://
```
) → link note (async, auto-polls until done)
Local image path → image note (async, auto-polls until done)
Otherwise → text note (sync)

bash

getnote save https://example.com --title "Great article"
getnote save "Remember to review the docs" --tag work --tag important
getnote save ./screenshot.png --title "Design mockup"

-o json

mode, silently polls and returns the final note JSON (including

title

content

/summary,

note_type

tags

created_at

getnote save <url|text|image_path> [--title <title>] [--tag <tag>]...

参数	说明
`--title`	可选标题
`--tag`	要添加的标签，可重复使用

输入为
```
http://
```
或
```
https://
```
开头的URL → 链接笔记（异步处理，自动轮询直到完成）
输入为本地图片路径 → 图片笔记（异步处理，自动轮询直到完成）
其他输入 → 文本笔记（同步处理）

bash

getnote save https://example.com --title "Great article"
getnote save "Remember to review the docs" --tag work --tag important
getnote save ./screenshot.png --title "Design mockup"

在

-o json

模式下，会静默轮询并返回最终的笔记JSON（包含

title

、

content

/摘要、

note_type

、

tags

、

created_at

字段）。

Track save task

查询保存任务进度

getnote task <task_id>

Manually check progress of an async save task.

bash

getnote task task_xyz789 -o json

Returns

status

(

pending

processing

success

failed

) and

note_id

when done.

getnote task <task_id>

手动检查异步保存任务的进度。

bash

getnote task task_xyz789 -o json

返回任务

status

（

pending

待处理 /

processing

处理中 /

success

成功 /

failed

失败），任务完成时会返回

note_id

。

List recent notes

列出最近的笔记

getnote notes [--since-id <id>] [--all]

Returns 20 notes per page (fixed). No

--limit

flag.

Flag	Description
`--since-id`	Pagination cursor (last note ID seen)
`--all`	Fetch all notes (auto-paginate, streams output)

bash

getnote notes
getnote notes --all
getnote notes --since-id 1234567890
getnote notes -o json

Note types:

plain_text

img_text

link

audio

meeting

local_audio

internal_record

class_audio

recorder_audio

recorder_flash_audio

getnote notes [--since-id <id>] [--all]

默认每页返回20条笔记（固定值），无

--limit

参数。

参数	说明
`--since-id`	分页游标（上次查询到的最后一条笔记ID）
`--all`	拉取所有笔记（自动分页，流式输出）

bash

getnote notes
getnote notes --all
getnote notes --since-id 1234567890
getnote notes -o json

笔记类型：

plain_text

img_text

link

audio

meeting

local_audio

internal_record

class_audio

recorder_audio

recorder_flash_audio

Get note details

获取笔记详情

getnote note <id> [--field <field>]

Returns full note including content, tags, attachments. Use

--field

to extract a single value.

`--field` values	Description
`id`	Note ID
`title`	Title
`content`	Content / AI summary
`type`	Note type
`created_at`	Creation time
`updated_at`	Last updated time
`url`	Source URL (link notes)
`excerpt`	Excerpt

bash

getnote note 1234567890
getnote note 1234567890 --field content
getnote note 1234567890 --field url
getnote note 1234567890 -o json

getnote note <id> [--field <field>]

返回完整的笔记信息，包括内容、标签、附件。使用

--field

参数可以提取单个字段的值。

可传入的 `--field` 值	说明
`id`	笔记ID
`title`	标题
`content`	内容 / AI摘要
`type`	笔记类型
`created_at`	创建时间
`updated_at`	最后更新时间
`url`	来源URL（仅链接笔记有该字段）
`excerpt`	摘要

bash

getnote note 1234567890
getnote note 1234567890 --field content
getnote note 1234567890 --field url
getnote note 1234567890 -o json

Update a note

更新笔记

getnote note update <id> [--title <title>] [--content <content>] [--tag <tags>]

Flag	Description
`--title`	New title
`--content`	New content (plain_text notes only)
`--tag`	Comma-separated tags — replaces all existing tags

bash

getnote note update 1234567890 --title "Updated title"
getnote note update 1234567890 --tag "work,important"

⚠️
--tag
replaces all tags. For partial tag changes use
getnote tag add/remove
. ⚠️ Content update only works on
plain_text
notes.

getnote note update <id> [--title <title>] [--content <content>] [--tag <tags>]

参数	说明
`--title`	新标题
`--content`	新内容（仅支持plain_text类型笔记）
`--tag`	逗号分隔的标签列表 — 会覆盖所有现有标签

bash

getnote note update 1234567890 --title "Updated title"
getnote note update 1234567890 --tag "work,important"

⚠️
--tag
会覆盖所有已有标签。如果需要局部修改标签请使用
getnote tag add/remove
命令。 ⚠️ 仅支持更新
plain_text
类型笔记的内容。

Delete a note

删除笔记

getnote note delete <id> [-y]

Moves note to trash.

bash

getnote note delete 1234567890 -y

getnote note delete <id> [-y]

将笔记移动到回收站。

bash

getnote note delete 1234567890 -y

Agent Usage Notes

Agent使用注意事项

Use
```
-o json
```
when parsing responses programmatically.

All JSON responses follow

{"success":true,"data":{...}}

structure, except:

```
save
```
(text): returns
```
{"note_id":"..."}
```
directly

save

(link/image): returns

{"data":{"tasks":[{"task_id":"..."}],...}}

task

: returns

{"success":true,"data":{"status":"...","note_id":"..."}}

```
notes
```
list returns 20 per page (no
```
--limit
```
); paginate with
```
--since-id
```
.
Note IDs are int64 — always handle as strings to avoid precision loss in JavaScript.
Exit code
```
0
```
= success; non-zero = error. Error details go to stderr.

编程解析响应时请使用
```
-o json
```
参数。

所有JSON响应都遵循

{"success":true,"data":{...}}

结构，以下情况除外：

保存文本笔记：直接返回
```
{"note_id":"..."}
```

保存链接/图片笔记：返回

{"data":{"tasks":[{"task_id":"..."}],...}}

查询任务：返回

{"success":true,"data":{"status":"...","note_id":"..."}}

笔记列表每次返回20条/页（无
```
--limit
```
参数）；可通过
```
--since-id
```
参数分页。
笔记ID为int64类型 — 请始终作为字符串处理，避免在JavaScript中出现精度丢失问题。
退出码
```
0
```
表示操作成功；非0表示出错，错误详情会输出到stderr。