Archbee CLI
Archbee CLI 安装与设置
在安装 Archbee CLI 之前，请确保您具备： Node. js 18 或更高版本 已安装 npm 如果使用 API 命令，则需要能够访问您的 Archbee 工作区 验证安装： 示例输出： 示例输出： 本地预览服务器启动地址： CLI 会自动检测受支持的配置文件。 示例： 示例输出： 尝试重新全局安装： 然后重启您的终端。 请确保您的项目包含以下受支持的配置文件之一： archbee.
Archbee CLI 身份验证指南
大多数 Archbee CLI API 命令需要： \--api-key --doc-space-id 示例： 空间 API 密钥的作用范围仅限于单个文档空间。 您可以从以下位置生成它们： 团队 API 密钥以下列内容开头： 团队管理员可以从以下位置创建它们： 团队 API 密钥可以访问多个空间。 大多数命令即使在使用团队 API 密钥时，也需要提供 --doc-space-id 值。 示例： 这些团队级命令仅使用团队 API 密钥即可运行： 导出 显示规则 创建空间 上传 列出文件 删除文件 移动文件 替换文件 只读团队 API 密钥无法修改内容。 以下这类命令在使用只读密钥时将失败： 创建文档 删除文档 发布空间 更新空间 请验证： 密钥尚未过期 密钥属于正确的团队或空间 命令中没有多余的空格或引号 请确保 API 密钥具有访问指定空间的权限。 对于更改数据的命令，请使用启用了写入权限的团队密钥。
Archbee CLI 命令示例
本指南展示了常见的 Archbee CLI 工作流程以及实用的命令示例。 大多数本地开发命令无需身份验证即可运行。与 Archbee 平台上的内容交互的命令通常同时需要 API 密钥和 space ID。 在本地编写或测试文档时使用这些命令。 在开发期间通过实时重载预览您的文档： 示例输出： 本地站点通常运行在： 验证您的文档结构和配置： 示例输出： 此命令有助于检测缺失的配置文件、无效的结构以及其他常见的设置问题。 检查损坏的内部链接： 示例输出： 这在发布更改之前非常有用。 大多数文档管理命令需要： \--api-key --doc-space-id 在文档空间中搜索文档： 示例输出： 通过 ID 检索文档： 示例输出： --format 标志支持 markdown、html、json 和 source 等格式。 从本地 markdown 文件创建新文档或更新现有文档： 示例输出： 从空间中删除文档： 示例输出： 请谨慎使用删除命令，因为它们会直接影响已发布的文档。 Archbee CLI 可以导入并同步 OpenAPI 规范，以生成 API 参考文档。 将 OpenAPI 文件同步到文档空间中： 示例输出： 检索有关现有 OpenAPI 文档树的信息： 示例输出： 如果同步失败，请在重试之前验证 OpenAPI schema。 CLI 还可以直接从终端管理已上传的文件。 上传文件： 示例输出： 列出已上传的文件和文件夹： 示例输出： 替换现有文件，同时保留相同的公共 URL： 示例输出： 将文档更新发布到生产环境： 示例输出： 请确保 API key 在发布之前具有写入权限。 每个 CLI 命令都支持 --help 标志。 示例： 示例输出： 这会显示所选命令支持的所有标志、参数和使用示例。 https //archbee. com/docs https //archbee.
Archbee CLI 故障排除
本指南涵盖了用户在使用 Archbee CLI 时遇到的最常见问题。 在提交支持工单之前，请先使用这些故障排查步骤。大多数问题都可以通过验证您的设置、检查身份验证或查看 CLI 命令选项来解决。 主要文档： https //archbee. com/docs https //archbee.