@almyty/client

中文文档
1.5.9发布于 2026/11/06Apache-2.0TypeScriptES Module零依赖构建来源已验证近 30 天下载 3007

Shared HTTP client and credential resolver used by the almyty CLIs. Reads ~/.almyty/credentials.json; not usually installed on its own.

原始使用文档
文档目录4 节
  1. Usage
  2. Exports
  3. Following a run
  4. About almyty

@almyty/client

Shared HTTP client and credential resolver used by all almyty CLI packages.

Usage

import { AlmytyClient, resolveCredentialsOrExit } from '@almyty/client';

const creds = resolveCredentialsOrExit();
const client = new AlmytyClient(creds.url, creds.token);

const agents = await client.listAgents();

Exports

  • AlmytyClient -- API client (agents, runs, gateways)
  • GatewayClient -- gateway-scoped client (invoke, stream, conversations)
  • resolveCredentials() -- read ~/.almyty/credentials.json (returns null if missing)
  • resolveCredentialsOrExit() -- same, but exits with an error message if missing
  • getOrgSlugFromToken(token) -- extract org slug from JWT
  • loadCredentials() -- raw file read
  • CREDENTIALS_FILE -- path to ~/.almyty/credentials.json
  • isPermanentStreamError(err) -- whether a run stream failed in a way a retry would not change

Following a run

client.followRun(agentId, runId, handler, signal?, options?) and the gateway's gw.streamRun(runId, handler, signal?, options?) keep watching a run until it ends. If the connection drops, they reconnect by themselves and carry on where they left off: each event reaches handler once and in order, and options.onLog gets the run's history one event at a time. If the run is gone, or not yours to see, they stop at once and throw an error with its status (400, 401, 403, 404 or 410); anything else (a network error, a server error) is retried a few times, waiting a little longer each time.

const run = await client.followRun(agentId, runId, (event) => {
  if (event.type === 'llm.chunk') process.stdout.write(String(event.data.content));
}, undefined, {
  onLog: (logged) => console.error(`#${logged.seq} ${logged.type}`),
});

To pick up a run you were already following, pass the position you had: { afterSeq, livePos }, which followRunStream returns and onReconnect reports.

About almyty

almyty is the full-stack platform for AI agents, agnostic by design: any LLM, any API turned into tools, served over MCP, A2A, UTCP, and Agent Skills. Open source, no lock-in.

Apache-2.0 © Almyty Inc.

版本与发布记录

@almyty/client 共发布 13 个版本,首次发布于 2026/04/22;过去 12 个月发布了 13 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.5.9latest2026/11/061 天前
1.5.82026/11/043 天前
1.5.72026/10/2216 天前
1.5.62026/10/2217 天前
1.5.52026/10/0929 天前
1.5.42026/10/0929 天前

关于 @almyty/client 的常见问题

@almyty/client 是什么?

Shared HTTP client and credential resolver used by the almyty CLIs. Reads ~/.almyty/credentials.json; not usually installed on its own.

如何安装 @almyty/client?

在项目目录运行 npm install @almyty/client,或使用 pnpm add / yarn add / bun add。

@almyty/client 支持 TypeScript 吗?

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

@almyty/client 支持 ESM 还是 CommonJS?

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

@almyty/client 可以商用吗?

@almyty/client 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@almyty/client 的下载量有多少?

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

@almyty/client 还在维护吗?

最新版本 1.5.9 发布于 2026/11/06(1 天前);至今共发布 13 个版本,其中过去 12 个月发布了 13 个;首次发布于 2026/04/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。