# @filen/sdk 中文文档

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

版本：0\.4\.2
npm 元数据更新时间：2026-07-11T00:11:45.568Z
中文译文更新时间：2026-11-14T18:07:42.279Z
软件包许可：AGPLv3

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

原始 npm 页面：https://www.npmjs.com/package/%40filen/sdk
原文对照：https://npmcn.com/package/%40filen/sdk/?lang=original
项目主页：https://sdk-ts-docs.filen.io/
源码仓库：https://github.com/FilenCloudDienste/filen-sdk-ts

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

- 包体积（解压后）：3 MB，933 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：15 个
- 首次发布：2024-02-22T19:45:11.049Z
- 最新版本发布：2026-07-11T00:11:45.467Z
- 近 30 天下载量：2373（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：208（近 12 个月 2 个）

## 中文简介

费伦 SDK

## 安装

```sh
npm install @filen/sdk
```

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

## README

  

### 费伦 SDK

SDK用于与 Filen 为 Node.JS 进行交互,浏览器和React Industrial.  
  
[**探索文件“**](https://sdk-ts-docs.filen.io/)  
  

![Contributors](https://img.shields.io/github/contributors/FilenCloudDienste/filen-sdk-ts?color=dark-green) ![Forks](https://img.shields.io/github/forks/FilenCloudDienste/filen-sdk-ts?style=social) ![Stargazers](https://img.shields.io/github/stars/FilenCloudDienste/filen-sdk-ts?style=social) ![Issues](https://img.shields.io/github/issues/FilenCloudDienste/filen-sdk-ts) ![License](https://img.shields.io/github/license/FilenCloudDienste/filen-sdk-ts)

### 安装

1.  使用国家预防机制安装

```sh
npm install @filen/sdk@latest
```

2.  初始化 SDK.

```typescript
import { FilenSDK } from "@filen/sdk"
import path from "path"
import os from "os"

type FilenSDKConfig = {
    email?: string
    password?: string
    twoFactorCode?: string
    masterKeys?: string[]
    apiKey?: string
    publicKey?: string
    privateKey?: string
    authVersion?: AuthVersion
    baseFolderUUID?: string
    userId?: number
    metadataCache?: boolean // Cache decrypted metadata in memory. Recommended.
    tmpPath?: string // Temporary local path used to store metadata and chunks. Only available in Node.JS.,
    connectToSocket?: boolean // Recommended if you are using the virtual FS class. Keeps the internal item tree up to date with remote changes.
}

// You can either directly supply all needed config parameters to the constructor or call the .login() function to fetch them using your login information.
const filen = new FilenSDK({
    metadataCache: true,
    connectToSocket: true,
    tmpPath: path.join(os.tmpdir(), "filen-sdk")
})

await filen.login({
    email: "your@email.com",
    password: "supersecret123",
    twoFactorCode: "123456"
})
```

3.  与云互动

```typescript
// Create a directory
await filen.fs().mkdir({
    path: "/Pictures"
})

// Upload a file
await filen.fs().upload({
    path: "/Pictures",
    source: "/Local/path/to/a/file.jpg"
})

// Read contents of the directory
const content: string[] = await filen.fs().readdir({
    path: "/Pictures"
})

// Stat a file
const stats: FSStats = await filen.fs().stat({
    path: "/Pictures/file.jpg"
})

// Download a file
await filen.fs().download({
    path: "/Pictures/file.jpg",
    destination: "/Local/path/to/a/file.jpg"
})

// Read a file
const content: Buffer = await filen.fs().readFile({
    path: "/Pictures/file.jpg"
})

// Write to a path
await filen.fs().writeFile({
    path: "/text.txt",
    content: Buffer.from("foobar", "utf-8")
})
```

## 许可证

根据AGPL-3.0许可证分发。 见 [自由主义](https://github.com/FilenCloudDienste/filen-sdk-ts/blob/main/LICENSE.md) 更多信息.

## 常见问题

### @filen/sdk 是什么？

费伦 SDK

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

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

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

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

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

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

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

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

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

@filen/sdk 使用 AGPLv3 许可。声明的许可为 AGPLv3，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @filen/sdk 的下载量有多少？

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

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

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