@getnote/cli 0.1.3 → 0.1.5

package/README.md

@@ -1,133 +1,199 @@
-# getnote-cli
+# Get笔记 CLI
 
-CLI tool for [Get笔记](https://biji.com) — manage notes and knowledge bases from the terminal.
+Get笔记的命令行工具，让你在终端和 AI Agent 里直接管理笔记和知识库。
 
-Designed for both humans and AI agents.
+存链接、记文字、搜笔记、管知识库——一条命令搞定，支持脚本和 AI Agent 调用。
 
-## Installation
+---
 
-### npm (recommended)
+## 安装
 
 ```bash
 npm install -g @getnote/cli
 ```
 
-### Manual
+或者从 [Releases](https://github.com/iswalle/getnote-cli/releases) 下载对应平台的二进制文件，放到 `$PATH` 里。
 
-Download the latest binary from [Releases](https://github.com/iswalle/getnote-cli/releases) and place it on your `$PATH`.
+---
 
-### Build from source
+## 三步开始用
 
+**第一步：安装**
 ```bash
-git clone https://github.com/iswalle/getnote-cli.git
-cd getnote-cli
-make install
+npm install -g @getnote/cli
 ```
 
-## Quick Start
-
+**第二步：登录**
 ```bash
-# Authenticate (OAuth browser flow)
 getnote auth login
+```
+会自动打开浏览器完成授权。也可以直接用 API Key：
+```bash
+getnote auth login --api-key gk_live_xxx
+```
 
-# Save a URL
-getnote save https://example.com/article --title "Great article"
+**第三步：开始用**
+```bash
+# 存一篇文章
+getnote save https://example.com/article --tag 阅读
 
-# Save plain text
-getnote save "Remember to review the docs" --tag work
+# 记一条文字
+getnote save "周五前要回复王总的邮件" --tag 待办
 
-# List recent notes
+# 看最近的笔记
 getnote notes
-
-# List all notes (auto-paginate)
-getnote notes --all
 ```
 
-## Commands
+---
 
-### Authentication
+## 典型使用场景
 
+**场景 1：边看边存**
+```bash
+# 存链接，自动抓取页面内容
+getnote save https://simonwillison.net/2024/llms-reading-list/ --tag ai
+
+# 存完自动展示笔记内容，不用再手动查
 ```
-getnote auth login                   Authenticate via OAuth (browser)
-getnote auth login --api-key <key>   Authenticate with API key directly
-getnote auth status                  Show authentication status
-getnote auth logout                  Remove saved credentials
+
+**场景 2：搜索笔记**
+```bash
+# 全局搜索
+getnote search "LLM 推荐阅读"
+
+# 在某个知识库内搜索
+getnote search "产品设计" --kb vnrOAaGY
 ```
 
-### Save & Tasks
+**场景 3：管理知识库**
+```bash
+# 列出所有知识库
+getnote kbs
+
+# 查看某个知识库的笔记
+getnote kb vnrOAaGY --all
 
+# 把笔记加入知识库
+getnote kb add vnrOAaGY 1234567890
 ```
-getnote save <url|text>              Save a URL or text note
-  --title <title>                    Optional title
-  --tag <tag>                        Tag (repeatable)
 
-getnote task <task_id>               Check the progress of an async save task
+**场景 4：脚本批处理**
+```bash
+# 导出所有笔记为 JSON
+getnote notes --all -o json > all-notes.json
+
+# 取出某条笔记的正文
+getnote note 1234567890 --field content | pbcopy
 ```
 
-### Notes
+---
 
+## AI Agent 使用
+
+所有命令支持 `-o json` 输出结构化数据，AI Agent 可以直接解析：
+
+```bash
+getnote notes -o json
+getnote note 1234567890 -o json
+getnote search "关键词" -o json
+getnote save https://example.com -o json   # 自动轮询，返回最终笔记
 ```
-getnote notes                        List recent notes (default 20)
-  --limit <n>                        Number of notes (default 20)
-  --since-id <id>                    Pagination cursor
-  --all                              Fetch all notes (auto-paginate)
 
-getnote note <id>                    Show note details
-  --field <name>                     Output a single field as plain text
-                                     (id, title, content, type,
-                                      created_at, updated_at, url, excerpt)
+`skills/` 目录下有 Claude Code 专用的 Skill 文件，加到项目上下文后，AI Agent 可以直接用自然语言操作笔记。
 
-getnote note update <id>             Update a note
-  --title <title>
-  --content <content>                plain_text notes only
-  --tag <tags>                       Comma-separated, replaces existing tags
+---
 
-getnote note delete <id>             Delete a note (moves to trash)
-  -y, --yes                          Skip confirmation
+## 完整命令参考
+
+### 认证
+
+```
+getnote auth login                   OAuth 登录（浏览器授权）
+getnote auth login --api-key <key>   直接用 API Key 登录
+getnote auth status                  查看当前登录状态
+getnote auth logout                  退出登录
 ```
 
-### Knowledge Bases
+### 保存笔记
 
 ```
-getnote kbs                          List all knowledge bases
+getnote save <url|文字|图片路径>      保存链接/文字/图片笔记
+  --title <标题>                      可选标题
+  --tag <标签>                        标签（可重复）
 
-getnote kb <topic_id>                List notes in a knowledge base
-  --limit <n>                        Number of notes (default 20)
-  --all                              Fetch all notes (auto-paginate)
+getnote task <task_id>               查看异步任务进度
+```
+
+链接笔记是异步处理的，CLI 会自动轮询等待完成，完成后直接展示内容。`-o json` 模式下静默轮询，返回最终笔记 JSON。
 
-getnote kb create <name>             Create a knowledge base
-  --desc <description>
+### 查看和管理笔记
 
-getnote kb add <topic_id> <note_id> [note_id...]     Add notes
-getnote kb remove <topic_id> <note_id> [note_id...]  Remove notes
+```
+getnote notes                        最近 20 条笔记
+  --limit <n>                        自定义数量
+  --all                              获取全部（自动翻页）
+
+getnote note <id>                    笔记详情
+  --field <字段名>                   只输出某个字段的值
+                                     （id/title/content/type/
+                                       created_at/url/excerpt）
+
+getnote note update <id>             更新笔记
+  --title <标题>
+  --content <内容>                   仅文字笔记可用
+  --tag <标签>                       逗号分隔，会替换现有标签
+
+getnote note delete <id>             删除笔记（移入回收站）
+  -y                                 跳过确认
 ```
 
-## Global Flags
+### 搜索
 
-| Flag | Description |
-|------|-------------|
-| `--api-key <key>` | Override API key for this command |
-| `-o, --output json\|table` | Output format (default: `table`) |
-| `--env prod\|dev` | Target environment (default: `prod`) |
+```
+getnote search <关键词>              全局语义搜索
+  --limit <n>                        返回数量（默认 10）
+  --kb <topic_id>                    限定在某个知识库内搜索
+```
 
-## Field Output (Pipe-friendly)
+### 标签
 
-Use `--field` to extract a single value for use in scripts:
+```
+getnote tag add <note_id> <标签>     给笔记加标签
+getnote tag remove <note_id> <标签>  删除笔记标签
+getnote tag list <note_id>           查看笔记的所有标签
+```
 
-```bash
-# Get note content
-getnote note 1234567890 --field content
+### 知识库
 
-# Get source URL of a link note
-getnote note 1234567890 --field url
+```
+getnote kbs                          列出所有知识库
 
-# Pipe into another command
-getnote note 1234567890 --field content | pbcopy
+getnote kb <topic_id>                知识库内的笔记
+  --limit <n>
+  --all                              获取全部
+
+getnote kb create <名称>             新建知识库
+  --desc <描述>
+
+getnote kb add <topic_id> <note_id> [note_id...]     加入知识库
+getnote kb remove <topic_id> <note_id> [note_id...]  移出知识库
 ```
 
-## Configuration
+---
+
+## 全局参数
 
-Credentials are stored in `~/.getnote/config.json`:
+| 参数 | 说明 |
+|------|------|
+| `--api-key <key>` | 临时覆盖 API Key |
+| `-o, --output json\|table` | 输出格式（默认 table） |
+| `--env prod\|dev` | 切换 API 环境 |
+
+---
+
+## 配置
+
+凭证保存在 `~/.getnote/config.json`：
 
 ```json
 {
@@ -136,18 +202,36 @@ Credentials are stored in `~/.getnote/config.json`:
 }
 ```
 
-Environment variables (higher priority than config file):
+也支持环境变量（优先级更高）：
 
-| Variable | Description |
-|----------|-------------|
-| `GETNOTE_API_KEY` | API key |
+| 变量 | 说明 |
+|------|------|
+| `GETNOTE_API_KEY` | API Key |
 | `GETNOTE_CLIENT_ID` | Client ID |
-| `GETNOTE_API_URL` | Override the API base URL |
+| `GETNOTE_API_URL` | 覆盖 API 地址 |
+
+---
+
+## 从源码构建
+
+需要 Go 1.21+。
+
+```bash
+git clone https://github.com/iswalle/getnote-cli.git
+cd getnote-cli
+make install
+```
+
+---
 
-## AI Agent Usage
+## 相关链接
 
-All commands support `-o json` for machine-readable output. See the [skills/](./skills/) directory for agent skill documentation.
+- [Get笔记官网](https://biji.com)
+- [Get笔记 OpenClaw Skill](https://github.com/iswalle/getnote-openclaw) — 在飞书/Telegram 等消息渠道用自然语言操作笔记
+- [Get笔记 MCP](https://github.com/iswalle/getnote-mcp) — MCP 协议接入，适配 Claude Desktop 等工具
+- [开放平台文档](https://openapi.biji.com/docs)
+- [问题反馈](https://github.com/iswalle/getnote-cli/issues)
 
 ## License
 
-MIT
+[MIT](https://opensource.org/licenses/MIT)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getnote/cli",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "CLI tool for Get笔记 — manage notes and knowledge bases from the terminal",
   "keywords": [
     "getnote",

package/scripts/postinstall.js

@@ -3,7 +3,6 @@
 
 'use strict';
 
-const https = require('https');
 const fs = require('fs');
 const path = require('path');
 const os = require('os');
@@ -17,21 +16,12 @@ function getPlatform() {
   const platform = os.platform();
   const arch = os.arch();
 
-  const platformMap = {
-    darwin: 'darwin',
-    linux: 'linux',
-    win32: 'windows',
-  };
-  const archMap = {
-    x64: 'amd64',
-    arm64: 'arm64',
-  };
+  const platformMap = { darwin: 'darwin', linux: 'linux', win32: 'windows' };
+  const archMap = { x64: 'amd64', arm64: 'arm64' };
 
   const p = platformMap[platform];
   const a = archMap[arch];
-  if (!p || !a) {
-    throw new Error(`Unsupported platform: ${platform}/${arch}`);
-  }
+  if (!p || !a) throw new Error(`Unsupported platform: ${platform}/${arch}`);
   return { platform: p, arch: a };
 }
 
@@ -45,31 +35,6 @@ function getDownloadURL(platform) {
   return `https://github.com/${REPO}/releases/download/v${VERSION}/${asset}`;
 }
 
-async function download(url, dest) {
-  return new Promise((resolve, reject) => {
-    const file = fs.createWriteStream(dest);
-    const get = (u) => {
-      https.get(u, (res) => {
-        if (res.statusCode === 301 || res.statusCode === 302) {
-          file.close();
-          get(res.headers.location);
-          return;
-        }
-        if (res.statusCode !== 200) {
-          reject(new Error(`Download failed: ${res.statusCode} ${u}`));
-          return;
-        }
-        res.pipe(file);
-        file.on('finish', () => file.close(resolve));
-      }).on('error', (err) => {
-        fs.unlink(dest, () => {});
-        reject(err);
-      });
-    };
-    get(url);
-  });
-}
-
 async function main() {
   const platform = getPlatform();
   const binDir = path.join(__dirname, '..', 'bin');
@@ -84,22 +49,26 @@ async function main() {
   fs.mkdirSync(binDir, { recursive: true });
 
   try {
-    await download(url, tmpFile);
-
+    // Use curl (available on macOS/Linux) or PowerShell (Windows) for reliable redirect handling
     if (platform.platform === 'windows') {
-      execSync(`unzip -o "${tmpFile}" "${binaryName}" -d "${binDir}"`);
+      execSync(
+        `powershell -Command "Invoke-WebRequest -Uri '${url}' -OutFile '${tmpFile}'"`,
+        { stdio: 'inherit' }
+      );
+      execSync(`powershell -Command "Expand-Archive -Path '${tmpFile}' -DestinationPath '${binDir}' -Force"`, { stdio: 'inherit' });
     } else {
-      execSync(`tar -xzf "${tmpFile}" -C "${binDir}" "${binaryName}"`);
+      execSync(`curl -fsSL "${url}" -o "${tmpFile}"`, { stdio: 'inherit' });
+      execSync(`tar -xzf "${tmpFile}" -C "${binDir}" "${binaryName}"`, { stdio: 'inherit' });
     }
 
     fs.chmodSync(binaryPath, 0o755);
     console.log(`getnote installed at ${binaryPath}`);
+  } catch (err) {
+    console.error('Failed to install getnote:', err.message);
+    process.exit(1);
   } finally {
     try { fs.unlinkSync(tmpFile); } catch (_) {}
   }
 }
 
-main().catch((err) => {
-  console.error('Failed to install getnote:', err.message);
-  process.exit(1);
-});
+main();