# @cloady/sdk 中文文档

规范地址：https://npmcn.com/package/%40cloady/sdk/

版本：0\.18\.0
npm 元数据更新时间：2026-11-04T05:43:39.598Z
中文译文更新时间：2026-11-10T03:56:56.903Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cloady/sdk
原文对照：https://npmcn.com/package/%40cloady/sdk/?lang=original
项目主页：https://cloady.com/

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

- 包体积（解压后）：739 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2026-07-12T20:18:58.204Z
- 最新版本发布：2026-11-04T05:43:39.420Z
- 近 30 天下载量：2843（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 21 个）

## 中文简介

为 Cloady API 创建 TypeScript 客户端 + 类型(从openapi.json).

## 安装

```sh
npm install @cloady/sdk
```

也可以使用：`pnpm add @cloady/sdk`、`yarn add @cloady/sdk`、`bun add @cloady/sdk`

## README

# @ clody/ sdk

类型脚本客户端 [克罗迪](https://cloady.com/) API——完全打入,由平台的OpenAPI合同生成. 仪表盘使用的相同的API.

## 安装

```sh
npm install @cloady/sdk
```

## 快速启动

在仪表板下创建 API 令牌 **账户 — API 令牌**。 。 。 .

```ts
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);
```

## 节点帮助

`@cloady/sdk/node` 以类似 CLI 的方式解析证书—— 存储自 `cloady login`,则 `CLOADY_TOKEN`数字 :

```ts
import { clientFromEnv } from "@cloady/sdk/node";

const cloady = clientFromEnv();
const { data } = await cloady.getMe();
```

## 文档

完整 API 引用时间 [droady.com/docs (英语)](https://cloady.com/docs)。 。 。 .

## 常见问题

### @cloady/sdk 是什么？

为 Cloady API 创建 TypeScript 客户端 \+ 类型\(从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 和提交记录判断。