@cloudfleet/sdk

中文文档
1.13.0发布于 2026/11/17MITTypeScriptES Module近 30 天下载 5390

Official TypeScript/JavaScript SDK for the Cloudfleet managed Kubernetes API

原始使用文档
文档目录4 节
  1. Installation
  2. Usage
  3. Errors
  4. License

Cloudfleet SDK for TypeScript & JavaScript

Official TypeScript/JavaScript SDK for the Cloudfleet API.

Cloudfleet is a managed Kubernetes platform that runs your clusters across any cloud and your own bare-metal servers. This SDK is a fully typed client for automating clusters, fleets, nodes, and billing from Node.js, the browser, or any TypeScript project.

Installation

npm install @cloudfleet/sdk

Usage

import { client } from "@cloudfleet/sdk";

client.setConfig({
    baseUrl: "https://api.cloudfleet.ai/v1",
    headers: {
        Authorization: "Bearer <your-token>",
    },
});

Errors

Failed requests throw (or return as error when throwOnError is false) Error subclasses:

  • CloudfleetApiError: the API answered with a non-2xx status. Carries status, method, path (the route template, e.g. /clusters/{cluster_id}), url, requestId, code, reason (Kubernetes Status.reason for cluster proxy calls), and the parsed response body. message is the body's message, or the response text when the body is not JSON. Other body fields, such as Kubernetes details, are on body.
  • CloudfleetNetworkError: no response was received. Carries method, path, url, and the original fetch error as cause.

Aborted requests and request or response validation errors are thrown unchanged.

message is the server's text and can contain personal data, such as the user's email in Kubernetes RBAC errors. When reporting errors to telemetry, title and group them by method, path and status, which never contain IDs or names.

KubernetesService calls always throw on failure, regardless of the client's throwOnError setting.

import { CloudfleetApiError, ClustersService } from "@cloudfleet/sdk";

try {
    await ClustersService.getCluster({
        path: { cluster_id: id },
        throwOnError: true,
    });
} catch (err) {
    if (err instanceof CloudfleetApiError && err.status === 404) {
        // cluster does not exist
    }
}

The default client converts errors automatically. For a client made with createClient, register the conversion with registerCloudfleetErrors(myClient).

The package ships full TypeScript types and an optional @tanstack/react-query integration via @cloudfleet/sdk/@tanstack/react-query. See the Cloudfleet docs for the full API reference and authentication details.

License

MIT

版本与发布记录

@cloudfleet/sdk 共发布 492 个版本,首次发布于 2025/01/22;过去 12 个月发布了 326 个版本。

版本发布日期距今
1.13.0latest2026/11/17今天
0.0.1-2f73d6dalpha2026/11/17今天
0.0.1-f4016f42026/11/17今天
0.0.1-f99d7af2026/11/17今天
0.0.1-019156c2026/11/098 天前
0.0.1-289b7702026/11/0610 天前

关于 @cloudfleet/sdk 的常见问题

@cloudfleet/sdk 是什么?

Official TypeScript/JavaScript SDK for the Cloudfleet managed Kubernetes API

如何安装 @cloudfleet/sdk?

在项目目录运行 npm install @cloudfleet/sdk,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:zod(^4.4.0)、react(^18 || ^19)、@tanstack/react-query(^5.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@cloudfleet/sdk 支持 TypeScript 吗?

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

@cloudfleet/sdk 支持 ESM 还是 CommonJS?

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

@cloudfleet/sdk 可以商用吗?

@cloudfleet/sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@cloudfleet/sdk 的下载量有多少?

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

@cloudfleet/sdk 还在维护吗?

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