@alfe.ai/config

中文文档
0.6.1发布于 2026/10/28TypeScriptESM + CJS近 30 天下载 4333

Read and write ~/.alfe/config.toml for Alfe CLI, gateway, runtimes, and published plugins.

原始使用文档
文档目录5 节
  1. What It Does
  2. Config Format
  3. Development
  4. Dependencies
  5. Links

@alfe.ai/config

Read and write ~/.alfe/config.toml for Alfe CLI, gateway, runtimes, and published plugins.

What It Does

Shared config management for the Alfe user-side tools (CLI, gateway daemon, plugins). Reads and writes the user's local config file at ~/.alfe/config.toml.

  • readConfig() — read and parse ~/.alfe/config.toml
  • writeConfig(config) — write config to ~/.alfe/config.toml
  • configExists() — check if config file exists
  • resolveConfig() — resolve environment overrides, file values, runtime, workspace, API origin, and voice HTTP origin
  • getEndpointFromToken(token) — derive API endpoint from token prefix (alfe_dev_, alfe_test_, alfe_live_)
  • mergeAndWriteConfig(partial) — atomically update owned top-level fields without deleting runtime tables
  • writeRuntimeConfig(name, config) — atomically update one runtime table

Config Format

# ~/.alfe/config.toml
api_key = "alfe_live_xxxx..."
gateway = "https://api.alfe.ai"  # optional override
gateway_url = "wss://gateway.alfe.ai/ws" # optional daemon relay override
runtime = "openclaw"

[runtimes.openclaw]
workspace = "/home/alfe/.openclaw"

Resolution precedence is ALFE_API_KEY / ALFE_API_URL, then the config file, then token-prefix endpoint derivation. Plaintext HTTP/WS overrides are accepted only for loopback development. The credential file is atomically replaced with mode 0600 inside an owner-only ~/.alfe directory; concurrent writers are serialized across processes.

writeConfig() intentionally replaces the complete document. Commands that own only a subset must use mergeAndWriteConfig().

Development

pnpm install
pnpm --filter @alfe.ai/config lint
pnpm --filter @alfe.ai/config typecheck
pnpm --filter @alfe.ai/config test
pnpm --filter @alfe.ai/config build

Dependencies

  • smol-toml — TOML parsing and serialization

版本与发布记录

@alfe.ai/config 共发布 18 个版本,首次发布于 2026/03/27;过去 12 个月发布了 18 个版本。

版本发布日期距今
0.6.1latest2026/10/289 天前
0.6.02026/10/2214 天前
0.5.02026/10/1917 天前
0.4.22026/10/1422 天前
0.4.12026/08/033 个月前
0.4.02026/07/313 个月前

关于 @alfe.ai/config 的常见问题

@alfe.ai/config 是什么?

Read and write ~/.alfe/config.toml for Alfe CLI, gateway, runtimes, and published plugins.

如何安装 @alfe.ai/config?

在项目目录运行 npm install @alfe.ai/config,或使用 pnpm add / yarn add / bun add。

@alfe.ai/config 支持 TypeScript 吗?

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

@alfe.ai/config 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@alfe.ai/config 可以商用吗?

@alfe.ai/config 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@alfe.ai/config 的下载量有多少?

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

@alfe.ai/config 还在维护吗?

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