# @computesdk/railway 中文文档

规范地址：https://npmcn.com/package/%40computesdk/railway/

版本：2\.0\.19
npm 元数据更新时间：2026-11-06T13:39:50.930Z
中文译文更新时间：2026-11-10T14:48:50.413Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：96 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：3 个
- 首次发布：2025-11-24T20:36:23.547Z
- 最新版本发布：2026-11-06T13:39:50.526Z
- 近 30 天下载量：8738（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：67（近 12 个月 67 个）

## 中文简介

计算SDK的铁路沙盒供应商 - 在铁路托管的沙盒中运行命令

## 安装

```sh
npm install @computesdk/railway
```

也可以使用：`pnpm add @computesdk/railway`、`yarn add @computesdk/railway`、`bun add @computesdk/railway`

## README

# @computesdk/铁路

计算SDK的铁路提供者 - 运行命令在 [铁路沙盒](https://docs.railway.com/sandboxes),ephemeric 计算环境 由铁路平台支撑.

## 安装

```bash
npm install @computesdk/railway
```

> **需要节点.js 22** - 基础 `railway` SDK依赖于节点22 API(例如全局性) `WebSocket`) (中文(简体) ).

## 设置

1.  在 [railway.com/账户/托肯](https://railway.com/account/tokens)。 。 。 .
2.  查找您想要运行的环境 ID( Railway 项目 – 环境设置) .
3.  设置环境变量 :

```bash
export RAILWAY_API_TOKEN=your_token_here
export RAILWAY_ENVIRONMENT_ID=your_environment_id_here
```

## 快速启动

配置 `compute` 与铁路供应商并创建一个沙盒:

```typescript
import { compute } from 'computesdk';
import { railway } from '@computesdk/railway';

compute.setConfig({
  provider: railway({
    token: process.env.RAILWAY_API_TOKEN,
    environmentId: process.env.RAILWAY_ENVIRONMENT_ID,
  }),
});

const sandbox = await compute.instances.create();

const result = await sandbox.runCommand('echo "hello from Railway"');
console.log(result.stdout);

await sandbox.destroy();
```

或者,在只需要一个供应商时直接给供应商工厂打电话:

```typescript
import { railway } from '@computesdk/railway';

const sdk = railway({ token: process.env.RAILWAY_API_TOKEN });
const sandbox = await sdk.sandbox.create();
```

## 配置

### 环境变量

| 变量 | 需求 | 说明 |
| --- | --- | --- |
| `RAILWAY_API_TOKEN` | 对 | 铁路API令牌曾被认证. |
| `RAILWAY_ENVIRONMENT_ID` | 建议 | 铁路环境沙盒通车. |

### 配置选项

```typescript
railway({
  token: '...',          // defaults to RAILWAY_API_TOKEN
  environmentId: '...',  // defaults to RAILWAY_ENVIRONMENT_ID
});
```

每个命令执行超时支持通过 `runCommand`'选项( e)`{ timeout: ms }`),它映射到铁路公司 `timeoutSec`。 。 。 .

## 支持的特性

| 特性 | 支助 | 页:1 |
| --- | --- | --- |
| 命令执行`runCommand`(中文(简体) ) | ✅ | 后卫 `sandbox.exec`。 。 。 . `timeout` 被映射到铁路公司 `timeoutSec`。 。 。 . |
| 文件系统( E)`filesystem.*`(中文(简体) ) | ✅ | 在壳上执行`cat`编号 :`base64`编号 :`mkdir`编号 :`ls`编号 :`rm`),因为铁路公司没有专门的文件系统API. |
| 列出沙盒( L)`list`(中文(简体) ) | ✅ | 假设在配置环境中的沙盒 . |
| 使用 ID 获取/ 销毁 | ✅ | 通过 `Sandbox.connect` 编号 : `sandbox.destroy`。 。 。 . |
| 港口接触量(`getUrl`(中文(简体) ) | ❌ | 铁路沙盒不曝光公用一港URL. |
| 模板/快照 | ❌ | 铁路模板是建设时段的构建者(`Sandbox.template()`),不是一个ID地址资源,所以它们没有被映射到计算SDK模板/snapshot. |

## 限制

-   **无端口暴露.** `getUrl` 抛出... 铁路沙盒不公布每个港口的公开URL.
-   **文件系统基于 shell.** 文件操作在沙盒内运行 shell 命令, 因此需要带有 POSIX shell `base64`, (中文(简体) ), `ls`,以及通常的creautils(在铁路默认图像上呈现).
-   **模板/相片不曝光.** 使用基础 `railway` SDK的车 `Sandbox.template()` 如果您需要自定义基础图像, 直接构建器 .

## 许可证

麻省理工学院

## 常见问题

### @computesdk/railway 是什么？

计算SDK的铁路沙盒供应商 - 在铁路托管的沙盒中运行命令

### 如何安装 @computesdk/railway？

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

### @computesdk/railway 支持 TypeScript 吗？

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

### @computesdk/railway 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @computesdk/railway 需要什么版本的 Node\.js？

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

### @computesdk/railway 可以商用吗？

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

### @computesdk/railway 的下载量有多少？

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

### @computesdk/railway 还在维护吗？

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