@getnote/cli
Advanced tools
+1
-1
| { | ||
| "name": "@getnote/cli", | ||
| "version": "0.1.7", | ||
| "version": "0.1.8", | ||
| "description": "CLI tool for Get笔记 — manage notes and knowledge bases from the terminal", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
| --- | ||
| name: getnote-auth | ||
| version: 0.2.0 | ||
| version: 0.3.0 | ||
| description: Manage authentication for Get笔记 CLI | ||
@@ -21,7 +21,7 @@ --- | ||
| |------|---------|-------------| | ||
| | OAuth (recommended) | `getnote auth login` | Opens browser to authorize | | ||
| | API Key | `getnote auth login --api-key <key>` | Saves key directly, no browser | | ||
| | OAuth (recommended) | `getnote auth login` | Opens browser to authorize; saves credentials automatically | | ||
| | API Key | `getnote auth login --api-key <key>` | Saves key directly, no browser needed | | ||
| ```bash | ||
| # OAuth flow | ||
| # OAuth flow (opens browser) | ||
| getnote auth login | ||
@@ -36,3 +36,3 @@ | ||
| API keys start with `gk_live_`. Get yours at: https://www.biji.com/settings/developer | ||
| Get your API key at: https://www.biji.com/settings/developer (keys start with `gk_live_`) | ||
@@ -47,2 +47,4 @@ --- | ||
| Shows whether authenticated and which API key is active. | ||
| ```bash | ||
@@ -60,3 +62,3 @@ getnote auth status | ||
| Removes saved credentials from local config. | ||
| Removes saved credentials from `~/.getnote/config.json`. | ||
@@ -73,3 +75,3 @@ ```bash | ||
| - If not authenticated, prompt the user to run `getnote auth login`. | ||
| - `--api-key` on any command is a temporary override and does not save credentials. | ||
| - Credentials are stored in `~/.getnote/config.json`; `auth logout` removes them. | ||
| - `--api-key` on any command is a temporary per-invocation override and does not save credentials. | ||
| - Credentials saved at `~/.getnote/config.json`; env vars `GETNOTE_API_KEY` / `GETNOTE_CLIENT_ID` take higher priority. |
| --- | ||
| name: getnote-kb | ||
| version: 0.2.0 | ||
| version: 0.3.0 | ||
| description: Manage knowledge bases in Get笔记 via the getnote CLI | ||
@@ -9,3 +9,3 @@ --- | ||
| Manage knowledge bases in Get笔记 — list, create, browse notes, add/remove notes. | ||
| Manage knowledge bases — list, create, browse notes, add/remove notes. | ||
@@ -24,2 +24,4 @@ ## Prerequisites | ||
| Returns all knowledge bases. Each item includes: `topic_id`, `name`, `description`, `note_count`, `created_at`. | ||
| ```bash | ||
@@ -38,2 +40,4 @@ getnote kbs | ||
| Returns 20 notes per page by default. | ||
| | Flag | Default | Description | | ||
@@ -46,3 +50,2 @@ |------|---------|-------------| | ||
| getnote kb vnrOAaGY | ||
| getnote kb vnrOAaGY --limit 5 | ||
| getnote kb vnrOAaGY --all | ||
@@ -62,5 +65,7 @@ getnote kb vnrOAaGY -o json | ||
| getnote kb create "Research Papers" | ||
| getnote kb create "Project Docs" --desc "Documentation links for the main project" | ||
| getnote kb create "Project Docs" --desc "Documentation links" | ||
| ``` | ||
| > Max 50 knowledge bases per day (resets at 00:00 Beijing time). | ||
| --- | ||
@@ -74,3 +79,3 @@ | ||
| Supports multiple note IDs in one call. | ||
| Supports multiple note IDs. Max 20 per call. | ||
@@ -82,2 +87,4 @@ ```bash | ||
| > Already-existing notes are silently skipped. | ||
| --- | ||
@@ -93,3 +100,2 @@ | ||
| getnote kb remove vnrOAaGY 1234567890 | ||
| getnote kb remove vnrOAaGY 1234567890 9876543210 | ||
| ``` | ||
@@ -102,4 +108,4 @@ | ||
| - Use `-o json` when parsing results programmatically. | ||
| - Get `topic_id` from `getnote kbs -o json` (the `id` field). | ||
| - Get `topic_id` from `getnote kbs -o json` (the `topic_id` field, not `id`). | ||
| - `kb add` / `kb remove` accept multiple note IDs — prefer batching over multiple calls. | ||
| - Exit code `0` = success; non-zero = error. Error details go to stderr. |
| --- | ||
| name: getnote-note | ||
| version: 0.2.0 | ||
| version: 0.3.0 | ||
| description: Manage notes in Get笔记 via the getnote CLI | ||
@@ -9,3 +9,3 @@ --- | ||
| Manage individual notes in Get笔记 — save, list, get, update, delete, and track save tasks. | ||
| Save, list, view, update, and delete notes in Get笔记. | ||
@@ -29,7 +29,6 @@ ## Prerequisites | ||
| - URL (`http://` or `https://`) → saved as link note | ||
| - Local image path → saved as image note | ||
| - Otherwise → saved as text note | ||
| - 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) | ||
| **Examples:** | ||
| ```bash | ||
@@ -41,4 +40,3 @@ getnote save https://example.com --title "Great article" | ||
| URL saves are async; the CLI auto-polls until done, then shows the result. | ||
| In `-o json` mode, silently polls and returns the final note JSON. | ||
| In `-o json` mode, silently polls and returns the final note JSON (including `title`, `content`/summary, `note_type`, `tags`, `created_at`). | ||
@@ -53,9 +51,10 @@ --- | ||
| Check progress of an async save task (returned by `save` for URLs). | ||
| Manually check progress of an async save task. | ||
| ```bash | ||
| getnote task task_xyz789 | ||
| getnote task task_xyz789 -o json | ||
| ``` | ||
| Returns `status` (`pending` / `processing` / `success` / `failed`) and `note_id` when done. | ||
| --- | ||
@@ -66,14 +65,14 @@ | ||
| ``` | ||
| getnote notes [--limit <n>] [--since-id <id>] [--all] | ||
| getnote notes [--since-id <id>] [--all] | ||
| ``` | ||
| | Flag | Default | Description | | ||
| |------|---------|-------------| | ||
| | `--limit` | 20 | Notes per page | | ||
| | `--since-id` | — | Pagination cursor (last note ID seen) | | ||
| | `--all` | — | Fetch all notes (auto-paginate, streams output) | | ||
| 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 --limit 5 | ||
| getnote notes --all | ||
@@ -84,2 +83,4 @@ getnote notes --since-id 1234567890 | ||
| **Note types**: `plain_text` / `img_text` / `link` / `audio` / `meeting` / `local_audio` / `internal_record` / `class_audio` / `recorder_audio` / `recorder_flash_audio` | ||
| --- | ||
@@ -93,5 +94,14 @@ | ||
| | Flag | Description | | ||
| Returns full note including content, tags, attachments. Use `--field` to extract a single value. | ||
| | `--field` values | Description | | ||
| |------|-------------| | ||
| | `--field` | Output a single field: `id` / `title` / `content` / `type` / `created_at` / `updated_at` / `url` / `excerpt` | | ||
| | `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 | | ||
@@ -117,3 +127,3 @@ ```bash | ||
| | `--content` | New content (plain_text notes only) | | ||
| | `--tag` | Comma-separated tags (replaces all existing tags) | | ||
| | `--tag` | Comma-separated tags — **replaces all existing tags** | | ||
@@ -125,2 +135,5 @@ ```bash | ||
| > ⚠️ `--tag` replaces all tags. For partial tag changes use `getnote tag add/remove`. | ||
| > ⚠️ Content update only works on `plain_text` notes. | ||
| --- | ||
@@ -136,8 +149,3 @@ | ||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `-y` | Skip confirmation prompt | | ||
| ```bash | ||
| getnote note delete 1234567890 | ||
| getnote note delete 1234567890 -y | ||
@@ -151,4 +159,4 @@ ``` | ||
| - Use `-o json` when parsing responses programmatically. | ||
| - `save` for URLs is async; in `-o json` mode the CLI auto-polls and returns the final note — no manual `task` polling needed. | ||
| - `note update --tag` replaces **all** existing tags; use `getnote tag add/remove` for partial updates. | ||
| - `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. |
| --- | ||
| name: getnote-search | ||
| version: 0.2.0 | ||
| version: 0.3.0 | ||
| description: Semantic search across notes in Get笔记 via the getnote CLI | ||
@@ -25,5 +25,9 @@ --- | ||
| |------|---------|-------------| | ||
| | `--kb` | — | Limit search to a knowledge base (topic_id) | | ||
| | `--kb` | — | Limit search to a knowledge base (`topic_id`) | | ||
| | `--limit` | 10 | Max results (max 10) | | ||
| Results are ranked by semantic relevance (high → low). Each result includes: `note_id`, `title`, `content` (excerpt), `created_at`, `note_type`. | ||
| > Note: `note_id` is only populated for `NOTE` type results. Other types (`FILE`, `BLOGGER`, `LIVE`, etc.) return an empty `note_id`. | ||
| ```bash | ||
@@ -46,4 +50,4 @@ # Search across all notes | ||
| - Get `topic_id` for `--kb` from `getnote kbs -o json`. | ||
| - Results are ranked by semantic relevance, not recency. | ||
| - Max `--limit` is 10; use `getnote notes` for broader browsing. | ||
| - For `NOTE` type results, use `getnote note <note_id>` to get the full content. | ||
| - Max `--limit` is 10; use `getnote notes` for browsing without a query. | ||
| - Exit code `0` = success; non-zero = error. Error details go to stderr. |
| --- | ||
| name: getnote-tag | ||
| version: 0.2.0 | ||
| version: 0.3.0 | ||
| description: Manage note tags in Get笔记 via the getnote CLI | ||
@@ -23,4 +23,9 @@ --- | ||
| Returns all tags including their IDs (needed for `tag remove`). | ||
| Returns all tags with their IDs and types. | ||
| Tag types: | ||
| - `ai` — auto-generated by AI | ||
| - `manual` — added by the user | ||
| - `system` — system tag (**cannot be deleted**) | ||
| ```bash | ||
@@ -51,10 +56,10 @@ getnote tag list 1896830231705320746 | ||
| > ⚠️ Requires **tag ID** (integer), not tag name. Run `getnote tag list <note_id>` first to get the ID. | ||
| > System tags cannot be removed. | ||
| > ⚠️ Requires **tag ID** (integer from `tag list`), not tag name. | ||
| > ⚠️ `system` type tags cannot be removed. | ||
| ```bash | ||
| # Get tag IDs first | ||
| # Step 1: get tag IDs | ||
| getnote tag list 1896830231705320746 -o json | ||
| # Remove by tag ID | ||
| # Step 2: remove by tag ID | ||
| getnote tag remove 1896830231705320746 123 | ||
@@ -67,4 +72,4 @@ ``` | ||
| - `tag remove` takes a **tag ID**, not a name — always call `tag list` first if you only have the name. | ||
| - For bulk tag replacement, use `getnote note update --tag` instead (replaces all tags at once). | ||
| - `tag remove` takes a **numeric tag ID**, not a name — always call `tag list` first. | ||
| - To replace all tags at once, use `getnote note update --tag "tag1,tag2"` instead. | ||
| - Exit code `0` = success; non-zero = error. Error details go to stderr. |
18864
6.09%