# @netgreener/sdk 中文文档

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

版本：0\.1\.8
npm 元数据更新时间：2026-11-01T21:45:04.106Z
中文译文更新时间：2026-11-01T23:56:22.447Z
软件包许可：UNLICENSED

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

原始 npm 页面：https://www.npmjs.com/package/%40netgreener/sdk
原文对照：https://npmcn.com/package/%40netgreener/sdk/?lang=original
项目主页：https://github.com/NetGreener/netgreener#readme
源码仓库：https://github.com/NetGreener/netgreener

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

- 包体积（解压后）：30.2 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-10-02T02:43:39.835Z
- 最新版本发布：2026-11-01T21:45:03.928Z
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

精简节点HTTP客户端NetGreener api\_server （Python netgreener\_sdk twin）。

## 安装

```sh
npm install @netgreener/sdk
```

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

## README

# @netgreener / sdk

薄 **节点** NetGreener的HTTP客户端 `api_server` （`/api/v1`）。  
蟒蛇的双胞胎 [`netgreener_sdk`](https://npmcn.com/package/%40netgreener/netgreener_sdk/README.md)． 同样的产品——没有Node服务器分支。

**状态:** **`@netgreener/sdk@0.1.0` 发表于npm。**  
在此之前也可以作为 `@netgreener/runtime/sdk`.

## 安装

```bash
npm install @netgreener/sdk
```

## 本地（此回购）

```bash
cd netgreener_js_sdk
npm run sync-from-runtime   # optional: refresh from netgreener_node
npm test
```

## 快速启动

```js
import { NetGreenerClient, ApiError } from '@netgreener/sdk'

const client = new NetGreenerClient()
await client.login('you@example.com', '…')
const me = await client.getMe()
console.log(me.email)

const project = await client.getOrCreateProject('My app', '/work/app', {
  gitUrl: 'https://github.com/acme/app.git',
  language: 'JavaScript',
})
```

## 业主发布

看到 [`OWNER_PUBLISH.md`](https://npmcn.com/package/%40netgreener/sdk/OWNER_PUBLISH.md) -代理商准备工作完成；NPM发布是你的。

## 常见问题

### @netgreener/sdk 是什么？

精简节点HTTP客户端NetGreener api\_server （Python netgreener\_sdk twin）。

### 如何安装 @netgreener/sdk？

在项目目录运行 npm install @netgreener/sdk，或使用 pnpm add / yarn add / bun add。

### @netgreener/sdk 支持 TypeScript 吗？

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

### @netgreener/sdk 支持 ESM 还是 CommonJS？

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

### @netgreener/sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @netgreener/sdk 可以商用吗？

@netgreener/sdk 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @netgreener/sdk 还在维护吗？

最新版本 0\.1\.8 发布于 2026/11/02（1 天前）；至今共发布 10 个版本，其中过去 12 个月发布了 10 个；首次发布于 2026/10/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。