Karakeep Skill
Advanced Karakeep bookmark management with full REST API support.
Add KARAKEEPSERVERURL and KARAKEEPAPIKEY to environment variables and jq for pretty-printing JSON responses.
If they are missing, provied a clear guide to the user.
IMPORTANT:always ask user to confirm beefore you delete a bookmark,
Complete Function Reference
Use this script karakeep-script.sh
We have the functions below:
| Function | Description |
|---|
| INLINECODE1 | Create bookmark (supports note) |
| INLINECODE2 |
Update bookmark note |
|
kb-delete | Delete bookmark |
|
kb-get | Get bookmark details |
|
kb-list | List all bookmarks (with limit) |
|
kb-content | Get markdown content |
|
kb-search | Search with qualifiers |
|
kb-lists | List all lists |
|
kb-create-list | Create new list |
|
kb-add-to-list | Add to list |
|
kb-remove-from-list | Remove from list |
|
kb-attach-tags | Attach tags |
|
kb-detach-tags | Detach tags |
Available Operations
Create Bookmark with Note
CODEBLOCK0
Update Bookmark Note
CODEBLOCK1
Delete Bookmark
CODEBLOCK2
Get Bookmark
CODEBLOCK3
Search Operations
CODEBLOCK4
API Parameters:
- -
q (required): Search query string with qualifiers - INLINECODE15 (optional): Results per page (default: server-controlled)
- INLINECODE16 (optional):
asc | desc | relevance (default) - INLINECODE20 (optional): Pagination cursor
- INLINECODE21 (optional): Include full content (default: true)
List Management
CODEBLOCK5
Tag Management
CODEBLOCK6
Notes
- - All responses are in JSON format
- Bookmark IDs are returned in creation responses
- Use
jq for pretty-printing JSON responses - API rate limits may apply
Karakeep 技能
高级 Karakeep 书签管理,支持完整的 REST API。
将 KARAKEEPSERVERURL 和 KARAKEEPAPIKEY 添加到环境变量中,并使用 jq 来美化 JSON 响应的输出。
如果缺少这些变量,请向用户提供清晰的指引。
重要提示:在删除书签之前,务必先请求用户确认。
完整函数参考
使用此脚本 karakeep-script.sh
我们提供以下函数:
| 函数 | 描述 |
|---|
| kb-create | 创建书签(支持笔记) |
| kb-update-note |
更新书签笔记 |
| kb-delete | 删除书签 |
| kb-get | 获取书签详情 |
| kb-list | 列出所有书签(可限制数量) |
| kb-content | 获取 Markdown 内容 |
| kb-search | 使用限定词搜索 |
| kb-lists | 列出所有列表 |
| kb-create-list | 创建新列表 |
| kb-add-to-list | 添加到列表 |
| kb-remove-from-list | 从列表移除 |
| kb-attach-tags | 附加标签 |
| kb-detach-tags | 分离标签 |
可用操作
创建带笔记的书签
bash
链接书签并添加笔记
kb-create link https://example.com 示例网站 我的分析和笔记...
文本书签并添加笔记
kb-create text 文本内容 我的笔记 附加笔记...
更新书签笔记
bash
kb-update-note bookmark_id 更新后的笔记内容...
删除书签
bash
kb-delete bookmark_id
获取书签
bash
kb-get bookmark_id
搜索操作
bash
使用限定词搜索(基于 MeiliSearch 后端)
kb-search is:fav after:2023-01-01 #important
kb-search machine learning is:tagged
kb-search list:reading #work
自定义限制数量和排序方式
kb-search python 50 desc # 50 条结果,降序排列
可用限定词:
- is:fav, is:archived, is:tagged, is:inlist
- is:link, is:text, is:media
- url:<值>, #<标签>, list:<名称>
- after:, before:
排序选项:relevance(默认), asc, desc
API 参数:
- - q(必填):带限定词的搜索查询字符串
- limit(可选):每页结果数(默认由服务器控制)
- sortOrder(可选):asc | desc | relevance(默认)
- cursor(可选):分页游标
- includeContent(可选):是否包含完整内容(默认:true)
列表管理
bash
列出所有列表
kb-lists
创建新列表
kb-create-list 阅读列表 📚
将书签添加到列表
kb-add-to-list bookmark
id listid
从列表移除书签
kb-remove-from-list bookmark
id listid
标签管理
bash
附加标签
kb-attach-tags bookmark_id 重要 待办 工作
分离标签
kb-detach-tags bookmark_id 旧标签 另一个旧标签
备注
- - 所有响应均为 JSON 格式
- 创建响应中会返回书签 ID
- 使用 jq 来美化 JSON 响应的输出
- 可能受 API 速率限制