@cloady/sdk
TypeScript client for the Cloady API — fully typed, generated from the platform's OpenAPI contract. The same API the dashboard uses.
Install
npm install @cloady/sdk
Quickstart
Create an API token in the dashboard under Account → API tokens.
import { createCloady } from "@cloady/sdk";
const cloady = createCloady({
auth: process.env.CLOADY_TOKEN,
});
const { data } = await cloady.deployApp({
path: { workspaceSlug: "acme" },
body: {
region: "eu1",
source: { type: "git", repoUrl: "github.com/acme/shop" },
},
});
console.log(data.app.status);
Node helpers
@cloady/sdk/node resolves credentials the same way the CLI does — stored config from cloady login, then CLOADY_TOKEN:
import { clientFromEnv } from "@cloady/sdk/node";
const cloady = clientFromEnv();
const { data } = await cloady.getMe();
Docs
Full API reference at cloady.com/docs.
关于 @cloady/sdk 的常见问题
@cloady/sdk 是什么?
Generated TypeScript client + types for the Cloady API (from openapi.json).
如何安装 @cloady/sdk?
在项目目录运行 npm install @cloady/sdk,或使用 pnpm add / yarn add / bun add。
@cloady/sdk 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@cloady/sdk 支持 ESM 还是 CommonJS?
以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@cloady/sdk 需要什么版本的 Node.js?
package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@cloady/sdk 可以商用吗?
@cloady/sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@cloady/sdk 的下载量有多少?
根据 npm 官方下载统计,@cloady/sdk 在 2026/10/10 – 2026/11/08 这 30 天内被下载 2,843 次,日均约 95 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@cloady/sdk 还在维护吗?
最新版本 0.18.0 发布于 2026/11/04(5 天前);至今共发布 21 个版本,其中过去 12 个月发布了 21 个;首次发布于 2026/07/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。