# ignitify 中文文档

规范地址：https://npmcn.com/package/ignitify/

版本：1\.2\.2
npm 元数据更新时间：2026-11-03T20:52:56.693Z
中文译文更新时间：2026-11-03T21:34:40.388Z
软件包许可：SEE LICENSE IN LICENSE

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

原始 npm 页面：https://www.npmjs.com/package/ignitify
原文对照：https://npmcn.com/package/ignitify/?lang=original
项目主页：https://ignitify.dev/

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

- 包体积（解压后）：908 kB，5 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.13
- 运行依赖：0 个
- 首次发布：2026-10-15T08:24:57.797Z
- 最新版本发布：2026-11-03T20:52:56.515Z
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

用于Ignitify的开发人员CLI：打包、部署和运行任务

## 安装

```sh
npm install ignitify
```

也可以使用：`pnpm add ignitify`、`yarn add ignitify`、`bun add ignitify`

## README

# ignitify

的命令行工具 [Ignitify](https://ignitify.dev/) 服务：创建、部署和运行任务。

## 安装

需要Node.js 22.13或更新版本。

```sh
npm install --global ignitify
ignitify --version
```

在CI中，或者对于一个命令，固定版本：

```sh
npx ignitify@1.2.0 whoami
```

如果安装失败 `EACCES`，请勿使用 `sudo`． 使用版本管理器安装Node.js，正如npm指南告诉你的： [https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally)

## 快速启动

```sh
ignitify login                      # sign this machine in
ignitify whoami                     # show your account, limits and usage
ignitify task:create hello          # register a task and write its files
ignitify task:deploy hello          # build it on the platform
ignitify task:run hello --wait      # run it and print the result
```

## 命令

每个命令都是 `<resource>:<verb>`。运行 `ignitify help` 对于列表，和 `ignitify <command> --help` 用于一个命令的标志。完整的参考资料在 [https://ignitify.dev/docs/cli](https://ignitify.dev/docs/cli) (所有命令在一个表中： [https://ignitify.dev/docs/cli/all](https://ignitify.dev/docs/cli/all)）.

| 集团 | 命令 |
| :-- | :-- |
| 任务 | `task:create`， `task:list`， `task:get`， `task:delete`， `task:validate`， `task:pack`， `task:deploy`， `task:run` |
| 集成 | `integration:add` |
| 部署 | `deployment:list`， `deployment:get`， `deployment:logs`， `deployment:delete` |
| 运行 | `run:list`， `run:get`， `run:logs`， `run:delete`， `run:cancel` |
| 虚拟机 | `vm:list`， `vm:get`， `vm:delete` |
| 秘密 | `secret:set`， `secret:list`， `secret:delete` |
| 日程安排 | `schedule:list`， `schedule:cancel` |
| 人则 | `hook:create`， `hook:list`， `hook:delete`， `notify:set` |
| 帐户及用途 | `login`， `logout`， `whoami`， `quota`， `usage`， `usage:export`， `help` |

全球标志: `--json` （标准输出一个JSON文档）， `-h, --help`， `-v, --version`． 删除和取消命令也使用 `-y, --yes` （对于脚本，回答“是”）。

## 配置

| 变量 | 使用 |
| :-- | :-- |
| `IGNITIFY_API_KEY` | 您的API密钥，用于CI。它战胜了保存的登录；当两者都存在时，CLI打印一个音符。 |
| `IGNITIFY_TASKS_DIR` | 保存任务文件夹的文件夹。默认值: `tasks`。 |
| `NO_COLOR` | 设置为任意值以关闭颜色。 |

在CI中，将API密钥放入CI密钥中，并将其作为 `IGNITIFY_API_KEY`。

## 密钥存储在哪里

`ignitify login` 保存密钥 `$XDG_CONFIG_HOME/ignitify/credentials.json` 当 `XDG_CONFIG_HOME` 是绝对路径，否则是in `~/.config/ignitify/credentials.json`． 文件夹的模式为0700，文件的模式为0600。 `ignitify logout` 撤销密钥并删除文件。

## 退出代码

| 代码 | 意义 |
| :-- | :-- |
| 0 | 命令执行成功。 |
| 1 | 命令执行失败。命令行在stderr上打印错误。 |
| 130 | 您在等待期间按了Ctrl+C。 |

代码同下 `npx`， `npm exec` 和 `npm run`，因此，当命令失败时，CI步骤将失败。在npm脚本中，使用 `npm run --silent` 如果你不想要npm自己的错误行。

## 代理

命令行使用Node.js的代理设置。集 `NODE_USE_ENV_PROXY=1` 一起 `HTTPS_PROXY` （Node.js 22.21或更新版本）：

```sh
NODE_USE_ENV_PROXY=1 HTTPS_PROXY=http://proxy.example.com:3128 ignitify whoami
```

## 更新

```sh
npm install --global ignitify@latest
```

CLI不会在后台检查更新。当服务需要更新的CLI时，CLI将在stderr上打印警告。

## 卸载

```sh
ignitify logout
npm uninstall --global ignitify
```

CLI除了凭据文件之外不保留任何数据，并且 `ignitify logout` 删除它。

## 平台

macOS和Linux（包括WSL）。Windows未被测试。

## 隐私

CLI不发送遥测信息。它只在您运行命令时向ignify API发送请求。每个请求命名CLI的版本。有两个命令也使用了公共的npm注册表： `integration:add` 运行NPM下载集成包 `task:validate` 向注册中心询问任务中每个集成的最新版本（当无法到达注册中心时，它将跳过此检查）。 `ignitify login` 还发送您的计算机名称，或您给的名称 `--name`，作为新密钥的标签。

## 版本控制

这个包遵循语义版本控制。公共界面是：命令名、标志、退出代码、 `--json` 输出, `IGNITIFY_API_KEY`， `IGNITIFY_TASKS_DIR`、凭据路径以及支持的Node.js版本。只有在新的主版本中才会出现打破其中一个的更改。

## 支持和安全

发送错误报告和安全报告给 [admin@ignitify.dev](mailto:admin@ignitify.dev)，或使用 [https://ignitify.dev/contact](https://ignitify.dev/contact)． 文档: [https://ignitify.dev/docs](https://ignitify.dev/docs)。

永远不要将API密钥粘贴到报表中。

## 执照

CLI可以免费安装、运行和阅读，但它不是开源的：请参阅许可证以了解您可以做什么。命令写入您的项目中的文件是您可以使用、更改和共享的（许可证第2节）。此包中第三方代码的许可证在 `ignitify-NOTICE.txt`。

## 常见问题

### ignitify 是什么？

用于Ignitify的开发人员CLI：打包、部署和运行任务

### 如何安装 ignitify？

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

### ignitify 支持 TypeScript 吗？

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

### ignitify 需要什么版本的 Node\.js？

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

### ignitify 可以商用吗？

ignitify 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### ignitify 还在维护吗？

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