# @hailer/cli 中文文档

规范地址：https://npmcn.com/package/%40hailer/cli/

版本：1\.2\.3
npm 元数据更新时间：2026-10-09T07:52:31.790Z
中文译文更新时间：2026-11-17T06:18:20.463Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40hailer/cli
原文对照：https://npmcn.com/package/%40hailer/cli/?lang=original
项目主页：https://bitbucket.org/hailer/hailer-cli#readme
源码仓库：https://bitbucket.org/hailer/hailer-cli

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

- 包体积（解压后）：211 kB，46 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2023-08-10T14:19:18.592Z
- 最新版本发布：2026-10-09T07:52:31.635Z
- 近 30 天下载量：51226（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 4 个）

## 中文简介

海拉尔CLI

## 安装

```sh
npm install @hailer/cli
```

也可以使用：`pnpm add @hailer/cli`、`yarn add @hailer/cli`、`bun add @hailer/cli`

## README

# 海拉尔CLI

给 Haller 的命令行界面 。 它也可用于在程序上访问海拉尔.

## 使用为 Cli

所有后端 Socket API 命令都可以在 CLI 中获取.

已提供分页补全 .

每个命令的结果都存储在 `result` 变量.

## 安装

```sh
npm install -g @hailer/cli
```

用法 :

```sh
hailer-cli --user my.email@hailer.com
```

### 示例用途

示例用法:

```javascript
await api.wall2.new_post({ subject: 'This is a wall post.', text: 'Look, this is a cool wallpost made from the Cli.' })
```

```javascript
await api.wall2.remove_post(result._id)
```

## 程序用途

### 登录用户名和密码

这个例子在海拉尔创建了壁柱,再在5秒后取出后退出.

创建一个新的节点项目( N)`npm init`)或使用已有的。 添加 `hailer-cli` 作为依赖,使用 `npm install @hailer/cli`

```sh
mkdir my-hailer-app
cd my-hailer-app
npm init
npm install @hailer/cli
```

创建新文件 `run.js` 并粘贴以下代码(并使用导入行使用打字符):

```javascript
// import { Client } from '@hailer/cli'; // Use with typescript
const { Client } = require('@hailer/cli');

const options = {
    host: 'https://api.hailer.com',
    username: 'set-this',
    password: 'set-this',
};

Client.create(options).then(async (client) => {
    // Listen to signals from Hailer
    client.on('signals', ([name, meta]) => {
        // print all signals
        console.log('Signal:', name, meta);
    });

    // Make API request to create a new feed (wall) post.
    const post = await client.request('wall2.new_post', [{ subject: 'This is a wall post.', text: 'The content of my post' }]);

    console.log('Post created:', post);
    // client.disconnect();
}).catch(error => {
    console.log('Error:', error);
    process.exit(1);
});
```

设定 `username` 财务报告和审定财务报表 `password` 参数为有效的海拉尔账户.

使用浏览器登录到海拉尔并前往 `Feed` 可以看到剧本在行动.

启动程序 :

```sh
node run.js
```

### 自动同步函数内部

```javascript
// import { Client } from '@hailer/cli';
const { Client } = require('@hailer/cli');

// ...

const options = {
    host: 'https://api.hailer.com',
    username: 'set-this',
    password: 'set-this',
};

const client = await Client.create(options).catch(error => { console.log('Error:', error); process.exit(1); });

// Listen to signals from Hailer
client.on('signals', ([name, meta]) => {
    // print all signals
    console.log('Signal:', name, meta);
});

const post = await client.request('wall2.new_post', [{ subject: 'This is a wall post.', text: 'The content of my post' }]);

console.log('Post created:', post);

client.disconnect();
```

## Haller API 文档

为了了解你对海拉尔API能做什么,访问:

[https://api.hailer.com/apidocs (中文(简体) )](https://api.hailer.com/apidocs)

## 常见问题

### @hailer/cli 是什么？

海拉尔CLI

### 如何安装 @hailer/cli？

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

### @hailer/cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @hailer/cli 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @hailer/cli 可以商用吗？

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

### @hailer/cli 的下载量有多少？

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

### @hailer/cli 还在维护吗？

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

