Archbee CLI 命令示例
20 分
Archbee CLI 命令示例
本指南展示了常见的 Archbee CLI 工作流程以及实用的命令示例。
大多数本地开发命令无需身份验证即可运行。与 Archbee 平台上的内容交互的命令通常同时需要 API 密钥和 space ID。
本地开发
在本地编写或测试文档时使用这些命令。
在开发期间通过实时重载预览您的文档：
archbee dev示例输出：
Archbee local server running at http://localhost:3000
Watching files for changes...本地站点通常运行在：
http://localhost:3000验证您的文档结构和配置：
archbee validate示例输出：
✓ Configuration valid
✓ No structural issues found此命令有助于检测缺失的配置文件、无效的结构以及其他常见的设置问题。
检查损坏的内部链接：
archbee broken-links示例输出：
Scanning documentation...
✓ No broken links found这在发布更改之前非常有用。
管理文档
大多数文档管理命令需要：
- --api-key
- --doc-space-id
在文档空间中搜索文档：
archbee search-docs --api-key YOUR_API_KEY --doc-space-id SPACE_ID示例输出：
Found 12 matching documents通过 ID 检索文档：
archbee get-doc DOC_ID --format markdown --api-key YOUR_API_KEY --doc-space-id SPACE_ID示例输出：
Document exported successfully--format 标志支持 markdown、html、json 和 source 等格式。
从本地 markdown 文件创建新文档或更新现有文档：
archbee create-doc ./doc.md --api-key YOUR_API_KEY --doc-space-id SPACE_ID示例输出：
Document created successfully从空间中删除文档：
archbee delete-doc DOC_ID --api-key YOUR_API_KEY --doc-space-id SPACE_ID示例输出：
Document deleted successfully请谨慎使用删除命令，因为它们会直接影响已发布的文档。
OpenAPI 工作流程
Archbee CLI 可以导入并同步 OpenAPI 规范，以生成 API 参考文档。
将 OpenAPI 文件同步到文档空间中：
archbee sync-openapi openapi.yaml --api-key YOUR_API_KEY --doc-space-id SPACE_ID示例输出：
OpenAPI sync completed successfully检索有关现有 OpenAPI 文档树的信息：
archbee info-openapi TREE_ID --api-key YOUR_API_KEY --doc-space-id SPACE_ID示例输出：
OpenAPI tree contains 24 endpoints如果同步失败，请在重试之前验证 OpenAPI schema。
文件管理器命令
CLI 还可以直接从终端管理已上传的文件。
上传文件：
archbee upload ./logo.png --api-key YOUR_API_KEY示例输出：
File uploaded successfully列出已上传的文件和文件夹：
archbee list-files --api-key YOUR_API_KEY示例输出：
Found 42 files替换现有文件，同时保留相同的公共 URL：
archbee replace-file FILE_ID ./new-logo.png --api-key YOUR_API_KEY示例输出：
File replaced successfully“替换文件”命令会在保留相同公共 URL 的同时更新文件，这有助于避免文档中的链接失效。
发布变更
将文档更新发布到生产环境：
archbee publish-space --api-key YOUR_API_KEY --doc-space-id SPACE_ID示例输出：
Space published successfully请确保 API key 在发布之前具有写入权限。
获取命令帮助
每个 CLI 命令都支持 --help 标志。
archbee <command> --help示例：
archbee create-doc --help示例输出：
Usage: archbee create-doc [options]这会显示所选命令支持的所有标志、参数和使用示例。
其他资源
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.