Skip to content

Commit 99c7fef

Browse files
author
Walle
committed
fix: align all skills with actual CLI commands
1 parent 601f15c commit 99c7fef

5 files changed

Lines changed: 118 additions & 174 deletions

File tree

skills/getnote-auth/SKILL.md

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

77
# getnote-auth Skill
88

9-
Log in, log out, and check authentication status for the `getnote` CLI.
9+
Log in, log out, and check authentication status.
1010

1111
## Commands
1212

@@ -16,19 +16,16 @@ Log in, log out, and check authentication status for the `getnote` CLI.
1616
getnote auth login [--api-key <key>] [--client-id <id>]
1717
```
1818

19-
Two modes:
20-
2119
| Mode | Command | Description |
2220
|------|---------|-------------|
23-
| OAuth (recommended) | `getnote auth login` | Opens browser to authorize; saves credentials automatically |
24-
| API Key | `getnote auth login --api-key <key>` | Saves API key directly, no browser needed |
21+
| OAuth (recommended) | `getnote auth login` | Opens browser to authorize |
22+
| API Key | `getnote auth login --api-key <key>` | Saves key directly, no browser |
2523

26-
**Examples:**
2724
```bash
28-
# OAuth flow (opens browser)
25+
# OAuth flow
2926
getnote auth login
3027

31-
# Direct API key
28+
# API key directly
3229
getnote auth login --api-key gk_live_xxx
3330

3431
# API key + Client ID
@@ -45,9 +42,6 @@ API keys start with `gk_live_`. Get yours at: https://www.biji.com/settings/deve
4542
getnote auth status
4643
```
4744

48-
Shows whether the CLI is authenticated and which API key is in use.
49-
50-
**Example:**
5145
```bash
5246
getnote auth status
5347
```
@@ -60,9 +54,8 @@ getnote auth status
6054
getnote auth logout
6155
```
6256

63-
Removes the saved API key from local config.
57+
Removes saved credentials from local config.
6458

65-
**Example:**
6659
```bash
6760
getnote auth logout
6861
```
@@ -71,7 +64,7 @@ getnote auth logout
7164

7265
## Agent Usage Notes
7366

74-
- Always run `getnote auth status` before other commands to verify authentication.
67+
- Always run `getnote auth status` first to verify authentication before other commands.
7568
- If not authenticated, prompt the user to run `getnote auth login`.
76-
- The `--api-key` flag on any command overrides the saved config temporarily (does not save).
77-
- Credentials are stored locally; `auth logout` removes them.
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.

skills/getnote-kb/SKILL.md

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

77
# getnote-kb Skill
88

9-
Manage knowledge bases (话题/topic) in Get笔记 — list, create, and add or remove notes.
9+
Manage knowledge bases in Get笔记 — list, create, browse notes, add/remove notes.
1010

1111
## Prerequisites
1212

1313
- `getnote` CLI installed and authenticated (`getnote auth status` should show "Authenticated")
14-
- API key configured via `getnote auth login --api-key <key>` or the `GETNOTE_API_KEY` environment variable
1514

1615
## Commands
1716

18-
### List knowledge bases
17+
### List all knowledge bases
1918

2019
```
21-
getnote kb list [--output json|table]
20+
getnote kbs
2221
```
2322

24-
Returns all knowledge bases accessible to the authenticated user.
25-
26-
**Examples:**
2723
```bash
28-
# Human-friendly table
29-
getnote kb list
30-
31-
# Machine-readable JSON
32-
getnote kb list --output json
24+
getnote kbs
25+
getnote kbs -o json
3326
```
3427

3528
---
3629

37-
### Create a knowledge base
30+
### List notes in a knowledge base
3831

3932
```
40-
getnote kb create <name> [--desc <description>]
33+
getnote kb <topic_id> [--limit <n>] [--all]
4134
```
4235

43-
| Flag | Description |
44-
|------|-------------|
45-
| `--desc` | Optional description for the knowledge base |
36+
| Flag | Default | Description |
37+
|------|---------|-------------|
38+
| `--limit` | 20 | Notes per page |
39+
| `--all` || Fetch all notes (auto-paginate) |
4640

47-
**Examples:**
4841
```bash
49-
getnote kb create "Research Papers"
50-
getnote kb create "Project Docs" --desc "Documentation links for the main project"
42+
getnote kb vnrOAaGY
43+
getnote kb vnrOAaGY --limit 5
44+
getnote kb vnrOAaGY --all
45+
getnote kb vnrOAaGY -o json
5146
```
5247

5348
---
5449

55-
### List notes in a knowledge base
50+
### Create a knowledge base
5651

5752
```
58-
getnote kb notes <topic_id> [--limit <n>] [--output json|table]
53+
getnote kb create <name> [--desc <description>]
5954
```
6055

61-
| Flag | Default | Description |
62-
|------|---------|-------------|
63-
| `--limit` | 20 | Maximum number of notes to return |
64-
65-
**Examples:**
6656
```bash
67-
# List notes in a knowledge base
68-
getnote kb notes kb_abc123
69-
70-
# Get more results
71-
getnote kb notes kb_abc123 --limit 50
72-
73-
# Machine-readable output
74-
getnote kb notes kb_abc123 --output json
57+
getnote kb create "Research Papers"
58+
getnote kb create "Project Docs" --desc "Documentation links for the main project"
7559
```
7660

7761
---
@@ -82,15 +66,11 @@ getnote kb notes kb_abc123 --output json
8266
getnote kb add <topic_id> <note_id> [note_id...]
8367
```
8468

85-
Supports adding multiple notes in a single call.
69+
Supports multiple note IDs in one call.
8670

87-
**Examples:**
8871
```bash
89-
# Add a single note
90-
getnote kb add kb_abc123 note_xyz789
91-
92-
# Add multiple notes at once
93-
getnote kb add kb_abc123 note_xyz789 note_def456 note_ghi012
72+
getnote kb add vnrOAaGY 1234567890
73+
getnote kb add vnrOAaGY 1234567890 9876543210
9474
```
9575

9676
---
@@ -101,23 +81,16 @@ getnote kb add kb_abc123 note_xyz789 note_def456 note_ghi012
10181
getnote kb remove <topic_id> <note_id> [note_id...]
10282
```
10383

104-
Supports removing multiple notes in a single call.
105-
106-
**Examples:**
10784
```bash
108-
# Remove a single note
109-
getnote kb remove kb_abc123 note_xyz789
110-
111-
# Remove multiple notes at once
112-
getnote kb remove kb_abc123 note_xyz789 note_def456
85+
getnote kb remove vnrOAaGY 1234567890
86+
getnote kb remove vnrOAaGY 1234567890 9876543210
11387
```
11488

11589
---
11690

11791
## Agent Usage Notes
11892

119-
- Use `--output json` for all commands when parsing responses programmatically.
120-
- To get a `topic_id`, first call `getnote kb list --output json` and extract the `id` field.
121-
- `kb add` and `kb remove` accept multiple note IDs in a single call — prefer batching over multiple calls.
93+
- Use `-o json` when parsing results programmatically.
94+
- Get `topic_id` from `getnote kbs -o json` (the `id` field).
95+
- `kb add` / `kb remove` accept multiple note IDs — prefer batching over multiple calls.
12296
- Exit code `0` = success; non-zero = error. Error details go to stderr.
123-
- Combine with `getnote note list --output json` to get note IDs before adding them to a knowledge base.

0 commit comments

Comments
 (0)