# @ghxstship/xos-cli 中文文档

规范地址：https://npmcn.com/package/%40ghxstship/xos-cli/

版本：4\.16\.0
npm 元数据更新时间：2026-11-15T11:40:35.091Z
中文译文更新时间：2026-11-16T08:13:49.534Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40ghxstship/xos-cli
原文对照：https://npmcn.com/package/%40ghxstship/xos-cli/?lang=original
项目主页：https://github.com/ghxstship/atlas/tree/main/packages/cli#readme
源码仓库：https://github.com/ghxstship/atlas

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：53.9 kB，16 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.12\.0
- 运行依赖：1 个
- 首次发布：2026-11-01T14:24:04.245Z
- 最新版本发布：2026-11-15T11:40:34.716Z
- 近 30 天下载量：2943（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

xos:XOS公共API的命令行. 签入,选择一个组织,调用任何操作,导入,导出,验证罐子代码并测试webhooks.

## 安装

```sh
npm install @ghxstship/xos-cli
```

也可以使用：`pnpm add @ghxstship/xos-cli`、`yarn add @ghxstship/xos-cli`、`bun add @ghxstship/xos-cli`

## README

# @ghxstship/xos-cli (英语)

`xos`,XOS公共API的命令行. API引用中的每个操作都是命令;输出是终端中的表格,而JSON是脚本. 建造在 [`@ghxstship/xos-sdk`](https://www.npmjs.com/package/@ghxstship/xos-sdk). 要求节点js 22.12 或 后.

```sh
npm install --global @ghxstship/xos-cli
xos --version
```

## 签名和呼叫操作

```sh
export XOS_API_KEY="xos_live_..."
xos auth login --base-url https://api.ghxstship.tech/v1 --profile northwind
xos projects list --filter project_state.eq=Active --sort -created_at --limit 20
xos projects update <id> --data '{"name":"Fall Series"}' --if-match auto
xos call purchaseOrders.approve <id> --data @approval.json
```

密钥读取自 `XOS_API_KEY` 或者说 `--key-stdin`,不会从一面旗帜中跳出,配置文件保存到 `~/.config/xos/config.json`只有你才能读 在CI中,设置 `XOS_API_KEY` 财务报告和审定财务报表 `XOS_BASE_URL` 跳过 `auth login`。 。 。 .

其他命令 : `xos org` (简介和组织), `xos resources` 财务报告和审定财务报表 `xos ops` (发现行动), `xos import` 财务报告和审定财务报表 `xos export` (简体中文和JSON), `xos canon` (验证运河代码)和 `xos webhooks` (签名和核实测试交付)。 运行 `xos --help` 完整名单.

## 文档

指南 : [Xos CLI 软件](https://github.com/ghxstship/atlas/blob/main/apps/docs/content/guides/en-US/cli.md)。 。 。 .

## 许可证

麻省理工学院. 见 [自由主义](https://npmcn.com/package/%40ghxstship/xos-cli/LICENSE)XOS平台本身为AGPL-3.0-只.

## 常见问题

### @ghxstship/xos-cli 是什么？

xos:XOS公共API的命令行\. 签入,选择一个组织,调用任何操作,导入,导出,验证罐子代码并测试webhooks\.

### 如何安装 @ghxstship/xos-cli？

在项目目录运行 npm install @ghxstship/xos-cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 xos，可以用 npx xos 直接运行。

### @ghxstship/xos-cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/ghxstship\_\_xos-cli 是否存在。

### @ghxstship/xos-cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @ghxstship/xos-cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.12\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @ghxstship/xos-cli 可以商用吗？

@ghxstship/xos-cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @ghxstship/xos-cli 的下载量有多少？

根据 npm 官方下载统计，@ghxstship/xos-cli 在 2026/10/17 – 2026/11/15 这 30 天内被下载 2,943 次，日均约 98 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @ghxstship/xos-cli 还在维护吗？

最新版本 4\.16\.0 发布于 2026/11/15（今天）；至今共发布 17 个版本，其中过去 12 个月发布了 17 个；首次发布于 2026/11/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

