跳转到主要内容

概述

知识库(KB)命令让您可以直接从终端管理项目的维基式文档。所有 KB 命令通过 -p/--project flag 限定到某个项目。
知识库是项目级资源。每个页面属于且仅属于一个项目。如需私人的用户级内容,请使用个人笔记

命令

列出页面

# All pages in a project
apollo kb list -p "Apollo"

# Filter by folder
apollo kb list -p "Apollo" --folder "Architecture"

# Limit results
apollo kb list -p "Apollo" --limit 20
选项:
Flag描述
-p, --project <name>项目名称或 ID(必填)
--folder <name>按文件夹名称筛选
--limit <n>最大结果数(默认:50)

查看页面

# By title (fuzzy match)
apollo kb view "deployment guide"

# By UUID
apollo kb view 550e8400-e29b-41d4-a716-446655440000
显示完整的页面内容、文件夹、版本号和元数据。

搜索页面

在项目中按标题或内容搜索 KB 页面:
apollo kb search "authentication" -p "Apollo"
apollo kb search "API design" -p "Apollo" --limit 10
在标题和内容字段中使用不区分大小写的子字符串匹配。

创建页面

# With inline content
apollo kb create -t "Deployment Guide" -p "Apollo" --content "## Steps\n1. Build\n2. Deploy"

# From a file
apollo kb create -t "API Reference" -p "Apollo" --file ./api-docs.md

# In a specific folder
apollo kb create -t "Auth Flow" -p "Apollo" --content "..." --folder "Architecture"
选项:
Flag描述
-t, --title <title>页面标题(必填)
-p, --project <name>项目名称或 ID(必填)
--content <text>页面内容(markdown)
--file <path>从文件读取内容
--folder <name>放入指定文件夹

更新页面

# Update content
apollo kb update "Deployment Guide" --content "Updated deployment steps..."

# Update from file
apollo kb update "API Reference" --file ./api-docs-v2.md

# Move to a different folder
apollo kb update "Auth Flow" --folder "Security"

# Rename
apollo kb update "Deployment Guide" -t "Production Deployment Guide"

删除页面

软删除页面(之后可以恢复):
apollo kb delete "Old Draft"

列出文件夹

apollo kb folders -p "Apollo"
显示项目的所有 KB 文件夹及其父子关系。

JSON 输出

# List as JSON
apollo kb list -p "Apollo" --json

# Search as JSON
apollo kb search "auth" -p "Apollo" --json

# View as JSON (full content)
apollo kb view "Deployment Guide" --json

管道示例

# Get all page titles
apollo kb list -p "Apollo" --json | jq '.[].title'

# Export a page to a file
apollo kb view "API Reference" --json | jq -r '.content' > api-reference.md