跳转到内容

CLI 使用指南

Get 笔记 CLI 使用指南

命令行工具,适合技术用户在终端、脚本、自动化工作流中使用 Get 笔记。


第一步:安装 CLI

确保电脑已安装 Node.js(v18+),然后执行:

npm install -g @getnote/cli

验证安装:

getnote --version

第二步:授权登录(推荐)

执行授权命令,会自动打开浏览器:

getnote auth

Get 笔记账号登录完成授权即可,无需手动填写 API Key。

💡 授权模式更安全、更简单,推荐所有用户使用

常用命令

保存笔记

# 保存文本
getnote save "今天学到了一个重要概念:..."

# 保存链接(异步处理)
getnote save "https://example.com/article"

# 保存 Get 笔记分享链接(同步,立即返回 note_id)
getnote save "https://d.biji.com/GCTEBxxx"

# 加标签
getnote save "笔记内容" --tag 学习 --tag 重要

# 保存到指定知识库
getnote save "笔记内容" --topic 知识库ID

查看笔记列表

getnote notes
getnote notes --limit 20

搜索笔记

getnote search "番茄工作法"
getnote search "Python 学习"

生成分享链接

getnote share <note_id>

知识库管理

# 查看知识库列表
getnote kb list

# 笔记加入知识库
getnote kb add <topic_id> <note_id>

# 笔记从知识库移出
getnote kb remove <topic_id> <note_id>

JSON 格式输出(脚本友好)

getnote save "笔记内容" -o json
getnote notes -o json

自动化场景示例

每天定时保存日报

#!/bin/bash
DATE=$(date '+%Y-%m-%d')
getnote save "日报 $DATE:今日完成..." --tag 日报

批量保存链接

#!/bin/bash
while read url; do
  getnote save "$url"
  sleep 1
done < links.txt

注意事项

  • Node.js 版本:需要 v18 或以上
  • 会员要求:需要 Get 笔记会员账号
  • 异步链接:普通链接保存是异步的,AI 处理完才能看到标题;分享链接是同步的,立即返回
  • 授权失效:重新执行 getnote auth 即可

手动配置(高级)

如果你希望手动指定 API Key,设置环境变量:

# 添加到 ~/.zshrc 或 ~/.bashrc
export GETNOTE_API_KEY="gk_live_你的key"
export GETNOTE_CLIENT_ID="cli_你的clientid"

# 生效
source ~/.zshrc

API Key 和 Client ID 在 Get 笔记开放平台 创建应用后获取。


版本信息

  • 当前版本:1.1.1
  • npm:https://www.npmjs.com/package/@getnote/cli
  • GitHub:https://github.com/iswalle/getnote-cli