Skip to content

Commit 2102b4e

Browse files
author
Walle
committed
fix: align all skills with OpenClaw skill references (no --limit on notes, correct field names, note types)
1 parent 99c7fef commit 2102b4e

5 files changed

Lines changed: 79 additions & 54 deletions

File tree

skills/getnote-auth/SKILL.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: getnote-auth
3-
version: 0.2.0
3+
version: 0.3.0
44
description: Manage authentication for Get笔记 CLI
55
---
66

@@ -18,11 +18,11 @@ getnote auth login [--api-key <key>] [--client-id <id>]
1818

1919
| Mode | Command | Description |
2020
|------|---------|-------------|
21-
| OAuth (recommended) | `getnote auth login` | Opens browser to authorize |
22-
| API Key | `getnote auth login --api-key <key>` | Saves key directly, no browser |
21+
| OAuth (recommended) | `getnote auth login` | Opens browser to authorize; saves credentials automatically |
22+
| API Key | `getnote auth login --api-key <key>` | Saves key directly, no browser needed |
2323

2424
```bash
25-
# OAuth flow
25+
# OAuth flow (opens browser)
2626
getnote auth login
2727

2828
# API key directly
@@ -32,7 +32,7 @@ getnote auth login --api-key gk_live_xxx
3232
getnote auth login --api-key gk_live_xxx --client-id cli_xxx
3333
```
3434

35-
API keys start with `gk_live_`. Get yours at: https://www.biji.com/settings/developer
35+
Get your API key at: https://www.biji.com/settings/developer (keys start with `gk_live_`)
3636

3737
---
3838

@@ -42,6 +42,8 @@ API keys start with `gk_live_`. Get yours at: https://www.biji.com/settings/deve
4242
getnote auth status
4343
```
4444

45+
Shows whether authenticated and which API key is active.
46+
4547
```bash
4648
getnote auth status
4749
```
@@ -54,7 +56,7 @@ getnote auth status
5456
getnote auth logout
5557
```
5658

57-
Removes saved credentials from local config.
59+
Removes saved credentials from `~/.getnote/config.json`.
5860

5961
```bash
6062
getnote auth logout
@@ -66,5 +68,5 @@ getnote auth logout
6668

6769
- Always run `getnote auth status` first to verify authentication before other commands.
6870
- If not authenticated, prompt the user to run `getnote auth login`.
69-
- `--api-key` on any command is a temporary override and does not save credentials.
70-
- Credentials are stored in `~/.getnote/config.json`; `auth logout` removes them.
71+
- `--api-key` on any command is a temporary per-invocation override and does not save credentials.
72+
- Credentials saved at `~/.getnote/config.json`; env vars `GETNOTE_API_KEY` / `GETNOTE_CLIENT_ID` take higher priority.

skills/getnote-kb/SKILL.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
name: getnote-kb
3-
version: 0.2.0
3+
version: 0.3.0
44
description: Manage knowledge bases in Get笔记 via the getnote CLI
55
---
66

77
# getnote-kb Skill
88

9-
Manage knowledge bases in Get笔记 — list, create, browse notes, add/remove notes.
9+
Manage knowledge bases — list, create, browse notes, add/remove notes.
1010

1111
## Prerequisites
1212

@@ -20,6 +20,8 @@ Manage knowledge bases in Get笔记 — list, create, browse notes, add/remove n
2020
getnote kbs
2121
```
2222

23+
Returns all knowledge bases. Each item includes: `topic_id`, `name`, `description`, `note_count`, `created_at`.
24+
2325
```bash
2426
getnote kbs
2527
getnote kbs -o json
@@ -33,14 +35,15 @@ getnote kbs -o json
3335
getnote kb <topic_id> [--limit <n>] [--all]
3436
```
3537

38+
Returns 20 notes per page by default.
39+
3640
| Flag | Default | Description |
3741
|------|---------|-------------|
3842
| `--limit` | 20 | Notes per page |
3943
| `--all` || Fetch all notes (auto-paginate) |
4044

4145
```bash
4246
getnote kb vnrOAaGY
43-
getnote kb vnrOAaGY --limit 5
4447
getnote kb vnrOAaGY --all
4548
getnote kb vnrOAaGY -o json
4649
```
@@ -55,9 +58,11 @@ getnote kb create <name> [--desc <description>]
5558

5659
```bash
5760
getnote kb create "Research Papers"
58-
getnote kb create "Project Docs" --desc "Documentation links for the main project"
61+
getnote kb create "Project Docs" --desc "Documentation links"
5962
```
6063

64+
> Max 50 knowledge bases per day (resets at 00:00 Beijing time).
65+
6166
---
6267

6368
### Add notes to a knowledge base
@@ -66,13 +71,15 @@ getnote kb create "Project Docs" --desc "Documentation links for the main projec
6671
getnote kb add <topic_id> <note_id> [note_id...]
6772
```
6873

69-
Supports multiple note IDs in one call.
74+
Supports multiple note IDs. Max 20 per call.
7075

7176
```bash
7277
getnote kb add vnrOAaGY 1234567890
7378
getnote kb add vnrOAaGY 1234567890 9876543210
7479
```
7580

81+
> Already-existing notes are silently skipped.
82+
7683
---
7784

7885
### Remove notes from a knowledge base
@@ -83,14 +90,13 @@ getnote kb remove <topic_id> <note_id> [note_id...]
8390

8491
```bash
8592
getnote kb remove vnrOAaGY 1234567890
86-
getnote kb remove vnrOAaGY 1234567890 9876543210
8793
```
8894

8995
---
9096

9197
## Agent Usage Notes
9298

9399
- Use `-o json` when parsing results programmatically.
94-
- Get `topic_id` from `getnote kbs -o json` (the `id` field).
100+
- Get `topic_id` from `getnote kbs -o json` (the `topic_id` field, not `id`).
95101
- `kb add` / `kb remove` accept multiple note IDs — prefer batching over multiple calls.
96102
- Exit code `0` = success; non-zero = error. Error details go to stderr.

skills/getnote-note/SKILL.md

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
name: getnote-note
3-
version: 0.2.0
3+
version: 0.3.0
44
description: Manage notes in Get笔记 via the getnote CLI
55
---
66

77
# getnote-note Skill
88

9-
Manage individual notes in Get笔记 — save, list, get, update, delete, and track save tasks.
9+
Save, list, view, update, and delete notes in Get笔记.
1010

1111
## Prerequisites
1212

@@ -25,19 +25,17 @@ getnote save <url|text|image_path> [--title <title>] [--tag <tag>]...
2525
| `--title` | Optional title |
2626
| `--tag` | Tag to apply; may be repeated |
2727

28-
- URL (`http://` or `https://`) → saved as link note
29-
- Local image path → saved as image note
30-
- Otherwise → saved as text note
28+
- URL (`http://` or `https://`) → link note (async, auto-polls until done)
29+
- Local image path → image note (async, auto-polls until done)
30+
- Otherwise → text note (sync)
3131

32-
**Examples:**
3332
```bash
3433
getnote save https://example.com --title "Great article"
3534
getnote save "Remember to review the docs" --tag work --tag important
3635
getnote save ./screenshot.png --title "Design mockup"
3736
```
3837

39-
URL saves are async; the CLI auto-polls until done, then shows the result.
40-
In `-o json` mode, silently polls and returns the final note JSON.
38+
In `-o json` mode, silently polls and returns the final note JSON (including `title`, `content`/summary, `note_type`, `tags`, `created_at`).
4139

4240
---
4341

@@ -47,35 +45,38 @@ In `-o json` mode, silently polls and returns the final note JSON.
4745
getnote task <task_id>
4846
```
4947

50-
Check progress of an async save task (returned by `save` for URLs).
48+
Manually check progress of an async save task.
5149

5250
```bash
53-
getnote task task_xyz789
5451
getnote task task_xyz789 -o json
5552
```
5653

54+
Returns `status` (`pending` / `processing` / `success` / `failed`) and `note_id` when done.
55+
5756
---
5857

5958
### List recent notes
6059

6160
```
62-
getnote notes [--limit <n>] [--since-id <id>] [--all]
61+
getnote notes [--since-id <id>] [--all]
6362
```
6463

65-
| Flag | Default | Description |
66-
|------|---------|-------------|
67-
| `--limit` | 20 | Notes per page |
68-
| `--since-id` || Pagination cursor (last note ID seen) |
69-
| `--all` || Fetch all notes (auto-paginate, streams output) |
64+
Returns 20 notes per page (fixed). No `--limit` flag.
65+
66+
| Flag | Description |
67+
|------|-------------|
68+
| `--since-id` | Pagination cursor (last note ID seen) |
69+
| `--all` | Fetch all notes (auto-paginate, streams output) |
7070

7171
```bash
7272
getnote notes
73-
getnote notes --limit 5
7473
getnote notes --all
7574
getnote notes --since-id 1234567890
7675
getnote notes -o json
7776
```
7877

78+
**Note types**: `plain_text` / `img_text` / `link` / `audio` / `meeting` / `local_audio` / `internal_record` / `class_audio` / `recorder_audio` / `recorder_flash_audio`
79+
7980
---
8081

8182
### Get note details
@@ -84,9 +85,18 @@ getnote notes -o json
8485
getnote note <id> [--field <field>]
8586
```
8687

87-
| Flag | Description |
88+
Returns full note including content, tags, attachments. Use `--field` to extract a single value.
89+
90+
| `--field` values | Description |
8891
|------|-------------|
89-
| `--field` | Output a single field: `id` / `title` / `content` / `type` / `created_at` / `updated_at` / `url` / `excerpt` |
92+
| `id` | Note ID |
93+
| `title` | Title |
94+
| `content` | Content / AI summary |
95+
| `type` | Note type |
96+
| `created_at` | Creation time |
97+
| `updated_at` | Last updated time |
98+
| `url` | Source URL (link notes) |
99+
| `excerpt` | Excerpt |
90100

91101
```bash
92102
getnote note 1234567890
@@ -107,13 +117,16 @@ getnote note update <id> [--title <title>] [--content <content>] [--tag <tags>]
107117
|------|-------------|
108118
| `--title` | New title |
109119
| `--content` | New content (plain_text notes only) |
110-
| `--tag` | Comma-separated tags (replaces all existing tags) |
120+
| `--tag` | Comma-separated tags **replaces all existing tags** |
111121

112122
```bash
113123
getnote note update 1234567890 --title "Updated title"
114124
getnote note update 1234567890 --tag "work,important"
115125
```
116126

127+
> ⚠️ `--tag` replaces all tags. For partial tag changes use `getnote tag add/remove`.
128+
> ⚠️ Content update only works on `plain_text` notes.
129+
117130
---
118131

119132
### Delete a note
@@ -124,12 +137,7 @@ getnote note delete <id> [-y]
124137

125138
Moves note to trash.
126139

127-
| Flag | Description |
128-
|------|-------------|
129-
| `-y` | Skip confirmation prompt |
130-
131140
```bash
132-
getnote note delete 1234567890
133141
getnote note delete 1234567890 -y
134142
```
135143

@@ -138,6 +146,6 @@ getnote note delete 1234567890 -y
138146
## Agent Usage Notes
139147

140148
- Use `-o json` when parsing responses programmatically.
141-
- `save` for URLs is async; in `-o json` mode the CLI auto-polls and returns the final note — no manual `task` polling needed.
142-
- `note update --tag` replaces **all** existing tags; use `getnote tag add/remove` for partial updates.
149+
- `notes` list returns **20 per page** (no `--limit`); paginate with `--since-id`.
150+
- Note IDs are int64 — always handle as strings to avoid precision loss in JavaScript.
143151
- Exit code `0` = success; non-zero = error. Error details go to stderr.

skills/getnote-search/SKILL.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: getnote-search
3-
version: 0.2.0
3+
version: 0.3.0
44
description: Semantic search across notes in Get笔记 via the getnote CLI
55
---
66

@@ -22,9 +22,13 @@ getnote search <query> [--kb <topic_id>] [--limit <n>]
2222

2323
| Flag | Default | Description |
2424
|------|---------|-------------|
25-
| `--kb` || Limit search to a knowledge base (topic_id) |
25+
| `--kb` || Limit search to a knowledge base (`topic_id`) |
2626
| `--limit` | 10 | Max results (max 10) |
2727

28+
Results are ranked by semantic relevance (high → low). Each result includes: `note_id`, `title`, `content` (excerpt), `created_at`, `note_type`.
29+
30+
> Note: `note_id` is only populated for `NOTE` type results. Other types (`FILE`, `BLOGGER`, `LIVE`, etc.) return an empty `note_id`.
31+
2832
```bash
2933
# Search across all notes
3034
getnote search "大模型 API"
@@ -42,6 +46,6 @@ getnote search "机器学习" --limit 5 -o json
4246

4347
- Use `-o json` when parsing results programmatically.
4448
- Get `topic_id` for `--kb` from `getnote kbs -o json`.
45-
- Results are ranked by semantic relevance, not recency.
46-
- Max `--limit` is 10; use `getnote notes` for broader browsing.
49+
- For `NOTE` type results, use `getnote note <note_id>` to get the full content.
50+
- Max `--limit` is 10; use `getnote notes` for browsing without a query.
4751
- Exit code `0` = success; non-zero = error. Error details go to stderr.

skills/getnote-tag/SKILL.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: getnote-tag
3-
version: 0.2.0
3+
version: 0.3.0
44
description: Manage note tags in Get笔记 via the getnote CLI
55
---
66

@@ -20,7 +20,12 @@ Add, list, and remove tags on notes.
2020
getnote tag list <note_id>
2121
```
2222

23-
Returns all tags including their IDs (needed for `tag remove`).
23+
Returns all tags with their IDs and types.
24+
25+
Tag types:
26+
- `ai` — auto-generated by AI
27+
- `manual` — added by the user
28+
- `system` — system tag (**cannot be deleted**)
2429

2530
```bash
2631
getnote tag list 1896830231705320746
@@ -47,21 +52,21 @@ getnote tag add 1896830231705320746 工作
4752
getnote tag remove <note_id> <tag_id>
4853
```
4954

50-
> ⚠️ Requires **tag ID** (integer), not tag name. Run `getnote tag list <note_id>` first to get the ID.
51-
> System tags cannot be removed.
55+
> ⚠️ Requires **tag ID** (integer from `tag list`), not tag name.
56+
> ⚠️ `system` type tags cannot be removed.
5257
5358
```bash
54-
# Get tag IDs first
59+
# Step 1: get tag IDs
5560
getnote tag list 1896830231705320746 -o json
5661

57-
# Remove by tag ID
62+
# Step 2: remove by tag ID
5863
getnote tag remove 1896830231705320746 123
5964
```
6065

6166
---
6267

6368
## Agent Usage Notes
6469

65-
- `tag remove` takes a **tag ID**, not a name — always call `tag list` first if you only have the name.
66-
- For bulk tag replacement, use `getnote note update --tag` instead (replaces all tags at once).
70+
- `tag remove` takes a **numeric tag ID**, not a name — always call `tag list` first.
71+
- To replace all tags at once, use `getnote note update --tag "tag1,tag2"` instead.
6772
- Exit code `0` = success; non-zero = error. Error details go to stderr.

0 commit comments

Comments
 (0)