# @box/cli 中文文档 规范地址：https://npmcn.com/package/%40box/cli/ 版本：4\.10\.1 npm 元数据更新时间：2026-09-16T11:06:32.522Z 中文译文更新时间：2026-11-08T12:48:41.564Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40box/cli 原文对照：https://npmcn.com/package/%40box/cli/?lang=original 项目主页：https://github.com/box/boxcli#readme 源码仓库：https://github.com/box/boxcli ## 关键信息（来自 npm 元数据） - 包体积（解压后）：2.3 MB，262 个文件 - 模块格式：CommonJS - TypeScript 类型：未声明 - Node.js 要求：\>=18\.0\.0 - 运行依赖：29 个 - 首次发布：2018-12-14T01:53:36.335Z - 最新版本发布：2026-09-16T11:06:32.286Z - 近 30 天下载量：8276（2026-10-09 至 2026-11-07，npm 官方下载统计） - 已发布版本数：55（近 12 个月 11 个） ## 中文简介 Box API 的官方命令行界面. 包括官方AI代理技能:box/box-for-ai. ## 安装 ```sh npm install @box/cli ``` 也可以使用：`pnpm add @box/cli`、`yarn add @box/cli`、`bun add @box/cli` ## README ![“box-dev-logo”](https://github.com/box/sdks/blob/master/images/box-dev-logo.png) # 方框 CLI 数据 [![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges) ![Platform](https://img.shields.io/badge/node-18--22-blue) [![Coverage](https://coveralls.io/repos/github/box/boxcli/badge.svg?branch=main)](https://coveralls.io/github/box/boxcli?branch=main) Box CLI是一个方便用户的指令行工具,它允许技术和非技术用户利用Box API进行常规或批量动作. 无需写入任何代码,因为这些行为是通过 [一组命令](https://npmcn.com/package/%40box/cli/#readme-command-topics)。 。 。 . 除了其他功能外,Box CLI还包括以下功能: 功能: - [散装动作](https://npmcn.com/package/%40box/cli/docs/Bulk%20actions/README.md) - Csv文件可用于批量执行命令,电子表格的每行都作为单独的API呼叫处理. - 作为用户头 - 代表另一个用户行事. - 搜索 API - 在您的 Box Enterprise 账户中搜索文件和文件夹 . > **和AI探员一起工作?** 安装官员 [盒式技能](https://github.com/box/box-for-ai) (单位:千美元)`npx skills add box/box-for-ai`)帮助您的助手正确使用 Box CLI 和 Box API . ## 目录 - [开始](https://npmcn.com/package/%40box/cli/#readme-getting-started) - [CLI 安装](https://npmcn.com/package/%40box/cli/#readme-cli-installation) - [Windows (macOS) 安装器](https://npmcn.com/package/%40box/cli/#readme-windows--macos-installers) - [Linux 节点安装( C)](https://npmcn.com/package/%40box/cli/#readme-linux--node-install) - [快速登录](https://npmcn.com/package/%40box/cli/#readme-quick-login-with-the-official-box-cli-app) - [JWT 的 CLI 和服务器认证](https://npmcn.com/package/%40box/cli/#readme-cli-and-server-authentication-with-jwt) - [注销](https://npmcn.com/package/%40box/cli/#readme-logout) - [安全存储](https://npmcn.com/package/%40box/cli/#readme-secure-storage) - [何为安全存储](https://npmcn.com/package/%40box/cli/#readme-what-is-stored-securely) - [平台支持](https://npmcn.com/package/%40box/cli/#readme-platform-support) - [Linux 安装](https://npmcn.com/package/%40box/cli/#readme-linux-installation) - [自动迁移](https://npmcn.com/package/%40box/cli/#readme-automatic-migration) - [数据位置](https://npmcn.com/package/%40box/cli/#readme-data-location) - [使用量](https://npmcn.com/package/%40box/cli/#readme-usage) - [命令主题](https://npmcn.com/package/%40box/cli/#readme-command-topics) - [问题、虫子和特性请求?](https://npmcn.com/package/%40box/cli/#readme-questions-bugs-and-feature-requests) - [版本数](https://npmcn.com/package/%40box/cli/#readme-versions) - [支持的版本](https://npmcn.com/package/%40box/cli/#readme-supported-version) - [版本时间表](https://npmcn.com/package/%40box/cli/#readme-version-schedule) - [协助箱式CLI](https://npmcn.com/package/%40box/cli/#readme-contributing-to-the-box-cli) - [版权和许可证](https://npmcn.com/package/%40box/cli/#readme-copyright-and-license) ## 开始 ### CLI 安装 Windows和macOS都有安装器。 但是,如果您想在其他环境中构建CLI,则可以使用原始源代码. #### Windows (macOS) 安装器 要在您的机器上安装最新的 CLI, 请下载最新的 `.exe` 用于窗口或 `.pkg` 用于macOS 用于 [最新发布](https://github.com/box/boxcli/releases)。 。 。 . #### Linux 节点安装( C) 此外,CLI可以作为节点包被安装在包括Linux在内的任何平台上. 要做到这一点,你需要拥有 [节点联署材料](https://nodejs.org/) 安装在您的机器上. ```bash npm install --global @box/cli ``` ### 快速登录 安装后运行 `box login` 来报名 有三个选择: - **\[1\] 官方专箱CLI App** - 不需要设置应用程序。 使用预定义的范围仅限于内容动作. - **\[2\] 您自己的平台 OAuth app** ——为自定义范围或特定配置输入客户端ID和客户端秘密. - **\[q\] 退出** ——退出登录流量. 您也可以在提示时直接粘贴客户端ID(任何16到99个字符之间的输入都被确认为客户端ID). **快开始** - 跳过提示,直接通过官方Box CLI App授权: ```bash box login -d ``` 浏览器窗口打开以获得授权 。 一旦你允许访问,CLI创造了新的环境,你就可以出发了. 见 [认证文件](https://npmcn.com/package/%40box/cli/docs/authentication.md) 更多细节. **平台 App** - 运行 `box login`选择 `[2]`,然后从 [Box 开发者控制台](https://app.box.com/developers/console)见 [带有 OAuth 2.0 指南的框 CLI](https://developer.box.com/guides/cli/quick-start/) 编辑 [认证文件](https://npmcn.com/package/%40box/cli/docs/authentication.md) 用于设置指令. ### JWT 的 CLI 和服务器认证 或者,从CLI箱开始, [下载和安装](https://npmcn.com/package/%40box/cli/#readme-CLI-Installation) CLI, 使用 JWT 的服务器认证设置 Box 应用程序 从您的平台 App的配置页面下载 JSON 配置文件 [Box 开发者控制台](https://app.box.com/developers/console) 如下 [JWT CLI指南](https://developer.box.com/guides/cli/cli-docs/jwt-cli/)。然后,通过指向您的配置文件来设定 CLI : ```sh-session $ box configure:environments:add PATH_TO_CONFIG_FILE Successfully added CLI environment "default" ``` 如果您用 JWT 认证手动生成了您自己的私钥, 您需要将 CLI 指向 您的私密密钥文件位置 : ```sh-session $ box configure:environments:add PATH_TO_CONFIG_FILE --private-key-path PATH_TO_PRIVATE_KEY --name ManualKey Successfully added CLI environment "ManualKey" ``` ### 注销 要在当前环境中签名, 请运行 : ```bash box logout ``` 这将取消 Box 上的访问符并清除本地的快取 。 对 OAuth , 运行 `box login` 重新授权。 对于CCG和JWT,在下一个命令上会自动获取一个新的令牌. 使用 `-f` 跳过确认提示,或 `--on-revoke-failure=clear` 编号 : `--on-revoke-failure=abort` 当撤销令牌失败时控制行为。 见 [`box logout`](https://npmcn.com/package/%40box/cli/docs/logout.md) 详细情况. ## 安全存储 Box CLI 使用安全存储保护您的敏感数据: ### 何为安全存储 - **环境配置**:客户身份、客户秘密以及企业身份、私人钥匙和公共钥匙 - **身份验证**: 为所有配置环境访问令牌并刷新令牌 ### 平台支持 | 平台 | 安全存储 | 需要安装 | | --- | --- | --- | | **马科斯** | 键盘链 | 内建 | | **窗口** | 证书管理器 | 内建 | | **链接** | 特勤处( libsecret) | 可能需要安装 | ### Linux 安装 在 Linux 系统中, 您需要安装 `libsecret-1-dev` 安全储存. **说明**: 如果不安装 libsecret, CLI 将自动返回到纯文本文件中存储证书 `~/.box/`你仍然可以使用CLI, 但是为了安全起见,我们建议安装 libsecret. ### 自动迁移 当您升级到安全存储支持的版本时 : - 现有的纯文本证书会自动读取 - 在下一个令牌刷新或配置更新时, 证书会迁移到安全存储 - 在成功迁移后, 将自动删除旧的纯文本文件 - 不需要人工操作! ### 数据位置 - **安全存储**: 证书存储在您的OS 密钥链/证书管理器中 - **后退( 如果无法安全存储)**数字 : `~/.box/box_environments.json` 财务报告和审定财务报表 `~/.box/{environment}_token_cache.json` ## 使用量 ```sh-session $ box --version box-cli/0.0.0 darwin-x64 node-v10.10.0 $ box users:get --help Get information about a Box user USAGE $ box users:get [ID] ARGUMENTS ID [default: me] ID of the user to get; defaults to the current user OPTIONS -h, --help Show CLI help -s, --save Save report to default reports folder on disk -t, --token=token Provide a token to perform this call -v, --verbose Show verbose output, which can be helpful for debugging -y, --yes Automatically respond yes to all confirmation prompts --as-user=as-user Provide an ID for a user --bulk-file-path=bulk-file-path File path to bulk .csv or .json objects --csv Output formatted CSV --fields=fields Comma separated list of fields to show --json Output formatted JSON --no-color Turn off colors for logging --save-to-file-path=save-to-file-path Override default file path to save report $ box users:get Type: user ID: '77777' Name: Example User Login: user@example.com Created At: '2016-12-07T17:30:40-08:00' Modified At: '2018-11-15T17:33:06-08:00' Language: en Timezone: America/Los_Angeles Space Amount: 10737418240 Space Used: 53569393 Max Upload Size: 5368709120 Status: active Job Title: '' Phone: '' Address: '' Avatar URL: 'https://app.box.com/api/avatar/large/77777' ``` # 命令主题 - [`box ai`](https://npmcn.com/package/%40box/cli/docs/ai.md) - 请求使用Box AI支持LLMS。 这是直接使用的,而不是由AI代理使用. - [`box autocomplete`](https://npmcn.com/package/%40box/cli/docs/autocomplete.md) - 显示自动完成安装指令 - [`box collaboration-allowlist`](https://npmcn.com/package/%40box/cli/docs/collaboration-allowlist.md) - 清单合作许可列表条目 - [`box collaborations`](https://npmcn.com/package/%40box/cli/docs/collaborations.md) - 管理协作 - [`box collections`](https://npmcn.com/package/%40box/cli/docs/collections.md) - 列出你的收藏 - [`box comments`](https://npmcn.com/package/%40box/cli/docs/comments.md) - 管理文件的注释 - [`box configure`](https://npmcn.com/package/%40box/cli/docs/configure.md) - 配置盒式CLI - [`box device-pins`](https://npmcn.com/package/%40box/cli/docs/device-pins.md) - 列出您企业的所有设备指针 - [`box events`](https://npmcn.com/package/%40box/cli/docs/events.md) - 参加活动 - [`box file-requests`](https://npmcn.com/package/%40box/cli/docs/file-requests.md) - 将已有的文件请求复制到新文件夹 - [`box files`](https://npmcn.com/package/%40box/cli/docs/files.md) - 管理文件 - [`box folders`](https://npmcn.com/package/%40box/cli/docs/folders.md) - 管理文件夹 - [`box groups`](https://npmcn.com/package/%40box/cli/docs/groups.md) - 列出所有团体 - [`box help`](https://npmcn.com/package/%40box/cli/docs/help.md) - 显示 Box CLI 的帮助 - [`box hubs`](https://npmcn.com/package/%40box/cli/docs/hubs.md) - 当前用户的列表框枢纽 - [`box integration-mappings`](https://npmcn.com/package/%40box/cli/docs/integration-mappings.md) - 列出Slack集成绘图 - [`box legal-hold-policies`](https://npmcn.com/package/%40box/cli/docs/legal-hold-policies.md) - 法律控股政策清单 - [`box login`](https://npmcn.com/package/%40box/cli/docs/login.md) - 与 OAuth 2.0 签名,并创建一个新的环境(或用 -- reauthization 更新现有的环境). - [`box logout`](https://npmcn.com/package/%40box/cli/docs/logout.md) - 撤销访问令牌并清除本地令牌缓存. - [`box metadata-cascade-policies`](https://npmcn.com/package/%40box/cli/docs/metadata-cascade-policies.md) - 在文件夹上列出元数据级联政策 - [`box metadata-query`](https://npmcn.com/package/%40box/cli/docs/metadata-query.md) - 使用类似 SQL 的语法创建搜索以返回匹配特定元数据的项目 - [`box metadata-templates`](https://npmcn.com/package/%40box/cli/docs/metadata-templates.md) - 获取企业号中的所有元数据模板 - [`box oss`](https://npmcn.com/package/%40box/cli/docs/oss.md) - 打印Box CLI中使用的开源许可软件包清单 - [`box recent-items`](https://npmcn.com/package/%40box/cli/docs/recent-items.md) - 列出过去90天查阅的文件资料,最多1 000件 - [`box request`](https://npmcn.com/package/%40box/cli/docs/request.md) - 手动指定框 API 请求 - [`box retention-policies`](https://npmcn.com/package/%40box/cli/docs/retention-policies.md) - 列出企业的所有留存政策 - [`box search`](https://npmcn.com/package/%40box/cli/docs/search.md) - 在您的企业号搜索文件和文件夹 - [`box shared-links`](https://npmcn.com/package/%40box/cli/docs/shared-links.md) - 管理共享链接 - [`box sign-requests`](https://npmcn.com/package/%40box/cli/docs/sign-requests.md) - 名单签名请求 - [`box sign-templates`](https://npmcn.com/package/%40box/cli/docs/sign-templates.md) - 列表标志模板 - [`box storage-policies`](https://npmcn.com/package/%40box/cli/docs/storage-policies.md) - 清单存储政策 - [`box tasks`](https://npmcn.com/package/%40box/cli/docs/tasks.md) - 管理任务 - [`box terms-of-service`](https://npmcn.com/package/%40box/cli/docs/terms-of-service.md) - 列出贵国企业的服务条件 - [`box tokens`](https://npmcn.com/package/%40box/cli/docs/tokens.md) - 拿个纪念品 默认返回服务账户符号 - [`box trash`](https://npmcn.com/package/%40box/cli/docs/trash.md) - 列出垃圾桶中的所有项目 - [`box update`](https://npmcn.com/package/%40box/cli/docs/update.md) - 使用 GitHub 更新 BoxCLI - [`box users`](https://npmcn.com/package/%40box/cli/docs/users.md) - 列出所有方框用户 - [`box version`](https://npmcn.com/package/%40box/cli/docs/version.md) - [`box watermarking`](https://npmcn.com/package/%40box/cli/docs/watermarking.md) - 在物品上贴上水印 - [`box web-links`](https://npmcn.com/package/%40box/cli/docs/web-links.md) - 管理网页链接 - [`box webhooks`](https://npmcn.com/package/%40box/cli/docs/webhooks.md) - 列出所有网点 ## 问题、虫子和特性请求? [浏览发行票](https://github.com/box/boxcli/issues)或者,如果那样行不通的话, [提交新文件](https://github.com/box/boxcli/issues/new) 有人会回来找你的 如果你对 API框中,您可以发送到 [框开发者论坛](https://community.box.com/t5/Developer-Forum/bd-p/DeveloperForum)。 。 。 . ## 版本数 我们使用修改后的版本 [语义版本](https://semver.org/) 所有变化。 见 [版本策略](https://npmcn.com/package/%40box/cli/VERSIONS.md) 从2022年7月30日起生效的细节. ### 支持的版本 只支持当前SDK的MAJOR版本. 新的功能,功能,错误修正,和安全更新将只被添加到目前的MAJOR版本. 目前发行的版本处于我们SDK开发的前沿,面向正在积极开发,想要最新而最出名的客户. 我们没有说明新功能的发布日期,而是设定一个固定的次要或补丁发布cadence最长为2至3个月(而我们可能更经常地发布). 同时,没有关于重大或断裂释放的时间表。 相反,我们将提前四分之一通报即将发生的突破性变化,以使客户能够计划升级。 我们总是建议所有用户对使用中的任何主要版本运行最新发布的小版本。 我们强烈建议尽早在EOL日期之前升级到最新的SDK主版. ### 版本时间表 | 版本 | 支持的环境 | 状态 | 第一版发布 | EOL/ 终止 | | --- | --- | --- | --- | --- | | 页:1 | 节点.js 18 | | | | | 3个 | 节点.js 16 | 支助 | 2022年2月1日 (中文(简体) ) | 传统发展 | | 2个 | | 伊欧 | 2018年12月14日 (中文(简体) ) | 2022年2月1日 (中文(简体) ) | | 1个 | | 伊欧 | 2017年11月1日 (中文(简体) ) | 2018年12月14日 (中文(简体) ) | ## 协助箱式CLI 1. 克隆这回波. 2. 运行 `npm install`。 。 。 . 3. 运行 `npm test` 确保一切正常运行. 4. 进行您想要的更改 `src/` 目录。 确保添加相应的测试 输入 `test/` 目录! 5. 用您的修改创建一个拉动请求——我们将审查,帮助您得到合并. 详情请参见 [捐款准则](https://npmcn.com/package/%40box/cli/CONTRIBUTING.md)。 。 。 . ## 版权和许可证 版权2018 Box, Inc. 版权所有. 根据Apache许可证第2.0版("License"); 您不得使用此文件,除非符合许可证. 您可在下列地点获得许可证副本: [http://www.apache.org/licenses/LICENSE-2.0 (中文(简体) )](http://www.apache.org/licenses/LICENSE-2.0) 除非适用的法律要求或书面同意,否则软件 根据许可证发放的是在“AS IS”BASIS上发放的, 没有任何明示或暗示的警告或条件. 有关许可的特定语言的许可证 许可证的限制. 该软件包括第三方图书馆,这些图书馆按照自己的许可证条款分发; 见 [(原始内容存档于2013-10-10). LICENSE-TARTY.txt](https://npmcn.com/package/%40box/cli/LICENSE-THIRD-PARTY.txt) 详细情况. ## 常见问题 ### @box/cli 是什么？ Box API 的官方命令行界面\. 包括官方AI代理技能:box/box-for-ai\. ### 如何安装 @box/cli？ 在项目目录运行 npm install @box/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 box，可以用 npx box 直接运行。 ### @box/cli 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/box\_\_cli 是否存在。 ### @box/cli 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @box/cli 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @box/cli 可以商用吗？ @box/cli 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @box/cli 的下载量有多少？ 根据 npm 官方下载统计，@box/cli 在 2026/10/09 – 2026/11/07 这 30 天内被下载 8,276 次，日均约 276 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @box/cli 还在维护吗？ 最新版本 4\.10\.1 发布于 2026/09/16（1 个月前）；至今共发布 55 个版本，其中过去 12 个月发布了 11 个；首次发布于 2018/12/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。