joplin-apiManage Joplin notes, notebooks, and tags via Joplin Data API. Use when the user needs to create, read, update, delete, search, or organize Joplin notes progr...
Install via ClawdBot CLI:
clawdbot install killgfat/joplin-api通过 Joplin Data API 管理笔记、笔记本和标签。支持自定义主机地址和端口,适用于本地、Docker 或远程部署的 Joplin。
必需配置: JOPLIN_TOKEN (API Token)
可选配置: JOPLIN_HOST (默认:localhost), JOPLIN_PORT (默认:41184)
| 变量名 | 必需 | 默认值 | 说明 |
|--------|------|--------|------|
| JOPLIN_HOST | 可选 | localhost | Joplin 主机地址(IP 或域名) |
| JOPLIN_PORT | 可选 | 41184 | Joplin Data API 端口 |
| JOPLIN_TOKEN | 必需 | - | 从 Joplin Web Clipper 获取的 API Token |
方法 1: 使用配置模板
cd /root/.openclaw/workspace/skills/joplin-api
cp CONFIG.example .env
# 编辑 .env 填入你的 API Token
方法 2: 手动创建 .env 文件
# .env 文件内容
JOPLIN_HOST=localhost
JOPLIN_PORT=41184
JOPLIN_TOKEN=your_api_token_here
方法 3: 使用系统环境变量
export JOPLIN_TOKEN="your_token"
export JOPLIN_HOST="192.168.1.100" # 可选
export JOPLIN_PORT="41184" # 可选
pip install requests python-dotenv
cd /root/.openclaw/workspace/skills/joplin-api
cp CONFIG.example .env
编辑 .env 文件:
# Joplin Data API 配置
JOPLIN_HOST=localhost # 主机地址(IP、域名均可)
JOPLIN_PORT=41184 # API 端口
JOPLIN_TOKEN=your_api_token # 从 Joplin 获取的 API Token
.envpython3 scripts/joplin_ping.py
看到 ✅ 连接成功! 即表示配置正确。
使用 joplin 统一命令:
python3 scripts/joplin.py <command> [args]
# 测试连接
python3 scripts/joplin.py ping
# 查看统计
python3 scripts/joplin.py stats
# 最近笔记
python3 scripts/joplin.py recent --limit 5
# 列出所有笔记本
python3 scripts/joplin.py folders list
# 列出所有笔记
python3 scripts/joplin.py list --type notes
# 列出所有标签
python3 scripts/joplin.py tags list
# 查看某笔记本的笔记
python3 scripts/joplin.py folder-notes --folder "工作"
# 搜索笔记
python3 scripts/joplin.py search "会议纪要"
# 查看笔记详情
python3 scripts/joplin.py get --id <note_id>
# 查看笔记的标签
python3 scripts/joplin.py tags note-tags --note-id <note_id>
# 创建笔记
python3 scripts/joplin.py create --title "待办" --body "内容..."
python3 scripts/joplin.py create --title "笔记" --folder "工作"
# 更新笔记
python3 scripts/joplin.py update --id <note_id> --title "新标题"
python3 scripts/joplin.py update --id <note_id> --body "新内容"
# 移动笔记
python3 scripts/joplin.py move --note-id <note_id> --to-folder "归档"
# 添加标签
python3 scripts/joplin.py tags add --note-id <note_id> --tag "重要"
# 移除标签
python3 scripts/joplin.py tags remove --note-id <note_id> --tag-id <tag_id>
# 删除笔记
python3 scripts/joplin.py delete --id <note_id> --type notes
# 创建笔记本
python3 scripts/joplin.py folders create --name "新项目"
# 重命名笔记本
python3 scripts/joplin.py folders rename --id <folder_id> --name "新名称"
# 删除笔记本
python3 scripts/joplin.py folders delete --id <folder_id>
# 导出单条笔记
python3 scripts/joplin.py export --note-id <note_id> -o output.md
# 导出所有笔记
python3 scripts/joplin.py export --all -o ./backup
# 导入单个文件
python3 scripts/joplin.py import note.md --folder "导入"
# 导入整个目录
python3 scripts/joplin.py import ./notes --folder "批量导入"
# 批量移动整个笔记本
python3 scripts/joplin.py move --batch-from "旧文件夹" --batch-to "新文件夹"
JOPLIN_HOST=localhost
JOPLIN_PORT=41184
JOPLIN_HOST=192.168.1.100
JOPLIN_PORT=41184
JOPLIN_HOST=joplin.example.com
JOPLIN_PORT=443
python3 scripts/joplin.py create --title "临时想法" --body "..." --folder "Inbox"
# 查看 Inbox 有哪些笔记
python3 scripts/joplin.py folder-notes --folder "Inbox"
# 移动到对应分类
python3 scripts/joplin.py move --note-id <id> --to-folder "工作"
# 每周导出所有笔记
python3 scripts/joplin.py export --all -o ~/joplin-backup/$(date +%Y%m%d)
# 搜索相关笔记
python3 scripts/joplin.py search "机器学习"
# 批量添加标签
for id in $(...); do
python3 scripts/joplin.py tags add --note-id $id --tag "AI"
done
.env 文件无法连接:
认证失败:
权限问题:
chmod +x scripts/*.pyGenerated Mar 1, 2026
Individuals use the skill to automate note-taking, organize digital notes, and back up Joplin data. It enables quick capture of ideas via CLI, tagging for retrieval, and scheduled exports to prevent data loss.
Teams deploy Joplin on a server and use the skill to share notes, manage project documentation, and synchronize updates. It supports bulk imports for onboarding and searching across shared notebooks for distributed work.
Researchers and students utilize the skill to categorize study notes, export findings as Markdown for papers, and tag materials by topic. It helps in managing large collections of notes and integrating with other tools via API.
Writers and bloggers automate drafting and editing in Joplin, using the skill to move drafts between notebooks, add metadata tags, and export content for publishing. It streamlines the creation process from idea to output.
Sysadmins document configurations and procedures in Joplin, employing the skill for backup automation, searching troubleshooting notes, and updating documentation programmatically. It ensures reliable access to critical information.
Offer a cloud-based Joplin management service with basic automation free and premium features like advanced backups or team collaboration. Revenue comes from subscription tiers for businesses and power users.
Provide consulting services to set up and customize the skill for specific organizational needs, such as integrating with existing workflows or developing custom scripts. Revenue is generated through project-based fees.
Sell training courses and support packages to help users master the skill for personal or team productivity. Revenue streams include one-time course sales and ongoing support contracts.
💬 Integration Tip
Ensure Joplin's Web Clipper is enabled and test connectivity with the ping command before automating tasks to avoid errors.
Use the mcporter CLI to list, configure, auth, and call MCP servers/tools directly (HTTP or stdio), including ad-hoc servers, config edits, and CLI/type generation.
Connect to 100+ APIs (Google Workspace, Microsoft 365, GitHub, Notion, Slack, Airtable, HubSpot, etc.) with managed OAuth. Use this skill when users want to...
Build, debug, and deploy websites using HTML, CSS, JavaScript, and modern frameworks following production best practices.
YouTube Data API integration with managed OAuth. Search videos, manage playlists, access channel data, and interact with comments. Use this skill when users want to interact with YouTube. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway).
Scaffold, test, document, and debug REST and GraphQL APIs. Use when the user needs to create API endpoints, write integration tests, generate OpenAPI specs, test with curl, mock APIs, or troubleshoot HTTP issues.
Search for jobs across LinkedIn, Indeed, Glassdoor, ZipRecruiter, Google Jobs, Bayt, Naukri, and BDJobs using the JobSpy MCP server.