beamup
Send corrections to a CIGALE BeamUp server.
Client library
Usage
import { sendCorrections } from "@cigale/beamup";
await sendCorrections({
origin: "https://beamup.example.com",
corrections: [ ... ]
})
Server
Usage
Use the Docker image:
docker run -p 8000:3000 -e PROD=true -v ./db/:/app/db/:rw ghcr.io/cigaleapp/beamup:latest
-p: listen on host machine's :8000-e: set to production mode-v: mount host machine's ./db directory to container's /app/db (make sure that you can write to the dih)
Development
To install dependencies:
bun install
To run:
bun run src/index.ts
To develop:
bun run --watch src/index.ts
This project was created using bun init in bun v1.2.21. Bun is a fast all-in-one JavaScript runtime.
关于 @cigale/beamup 的常见问题
@cigale/beamup 是什么？
Typed client to send corrections to a CIGALE BeamUp server
如何安装 @cigale/beamup？
在项目目录运行 npm install @cigale/beamup，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^5.9.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@cigale/beamup 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@cigale/beamup 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@cigale/beamup 可以商用吗？
@cigale/beamup 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@cigale/beamup 的下载量有多少？
根据 npm 官方下载统计，@cigale/beamup 在 2026/10/10 – 2026/11/08 这 30 天内被下载 7,331 次，日均约 244 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@cigale/beamup 还在维护吗？
最新版本 0.6.5 发布于 2025/09/24（1.1 年前）；至今共发布 16 个版本，其中过去 12 个月发布了 0 个；首次发布于 2025/09/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。