← 返回创作台
使用文档
目录

网页快速开始

不安装任何东西,描述需求就生成应用

打开平台首页,用邮箱登录。在输入框描述你要的应用:页面长什么样、有哪些数据、要做什么操作。模型会生成一个单文件应用并自动部署。

生成完成后左侧预览会刷新,每个应用都有独立地址:<应用名>.<平台域名>。顶部「新建」从零开始,首页默认回到上次操作的应用。

描述越具体越好,例如:「做一个企业官网,首页有导航、产品列表和联系方式,数据存 SQLite」。不会写提示词,看下一篇。

AI 开发与提示词

照着模板描述,生成成功率更高

一个好的描述包含四部分:页面、数据、操作、风格。

可以直接套用这些模板:

  • 官网/落地页:公司介绍、产品列表、联系方式,表单提交存 SQLite,简洁商务风。
  • 管理后台:登录、列表、新增、编辑、删除,数据存 SQLite,表格式布局。
  • IoT 设备页:设备列表、在线状态、下发命令、显示最近上报,使用 MQTT。
  • 知识库:分类、条目、搜索,数据存 SQLite,支持导入文本。
  • 表单/工具:报名、投票、问卷,提交后写入数据库并展示统计。

修改时直接说「在原有基础上加一个搜索框」或「把列表改成卡片」,不要重新描述整个应用。生成失败就打开应用的日志 Tab,把报错一起发回去。

管理应用

列表、详情、Tab 和删除

顶部「应用」打开应用列表,只显示当前邮箱名下的应用。左侧选择应用,右侧按 Tab 查看:

  • 域名:平台二级域名、自定义域名、上线/下线。
  • 版本:部署历史、源码预览、回退。
  • 日志:请求日志和 console 输出,按请求 ID 分组。
  • 数据:表结构、前 20 行、直接执行 SQL。
  • 静态:上传、预览、下载 public/ 资源。
  • MQTT:连接地址、用户名、密码、主题和示例。
  • 用量:请求、流量、数据库、文件和 MQTT 统计。

域名 Tab 顶部显示「已上线 / 已下线 / 未部署」。下线只关闭域名路由,代码、数据库和文件都保留;删除不可恢复。

域名与上线

二级域名直接生效,自定义域名走 CNAME

平台分配的二级域名默认是 <应用名>.<平台域名>,部署后直接生效,不需要配置。

绑定自己的域名:在 Cloudflare 添加 CNAME 记录,指向平台 fallback 域名,并开启代理(橙色云)。然后在应用弹窗的「绑定域名」里输入该域名。

DNS 生效时间取决于 TTL,刚添加 CNAME 时可能需要等待几分钟。下线只关闭路由,不会删除代码和数据。

版本、日志与数据

回退、排错、看数据库和静态资源

版本:每次成功部署生成一个版本,可查看源码并一键回退;app.db 和 files/ 不参与回退。

日志:请求日志和 console 输出按请求 ID 分组,新日志在前。页面 500 或生成失败时先看这里。

数据:查看表结构和前 20 行,也可以直接执行 SQL。写操作会影响线上数据,谨慎使用。

静态:上传、预览、下载 public/ 下的资源;用量 查看请求、流量、数据库、文件和 MQTT 统计。

MQTT 与设备

在控制台拿凭证,设备只订阅自己的主题

应用的 MQTT Tab 会显示 broker 地址、用户名、密码、TLS 地址和主题权限。

  • 设备 → 应用:设备发布到 <app>,payload 里带 deviceId。
  • 应用 → 设备:应用发布到 <app>/<deviceId>,设备订阅自己的主题。

设备 id 用长随机串,clientId 用 <app>-<deviceId>。在线状态用心跳 + last_seen 判断,示例见 nb/examples/mqtt。

计费与充值

按用量扣费,余额与最近记录

按 DeepSeek Flash 官方价格的 7 倍计费,每次生成或修改后写入扣费记录。

顶部余额打开「余额与账单」:选择充值档位后走支付宝或 PayPal。订单与扣费分两个 Tab,各显示最近 30 条。

余额不足时请求返回 402,充值后立即恢复。

快速开始

装牛逼、脚本、应用、本地登录与远程部署

装牛逼(安装 NBJS):让 JS 更牛逼,让前端更牛逼。

Linux / macOS / WSL / Git Bash:

curl -fsSL https://nbjs.ai/nb.sh | sh

Windows PowerShell:

irm https://nbjs.ai/nb.ps1 | iex

Windows 桌面版(单文件,双击打开 nbjs.ai 并自动安装 nb 命令):

下载 Windows 便携版(79 MB)

双击 nb-ai.exe;首次启动会把内置的 nb.exe 装到 %LOCALAPPDATA%\Programs\nb 并加入 PATH。工作区在 exe 旁的 nb-ai-data\workspace。

桌面地址与 nb -r 共用 [server] remote(默认 https://nbjs.ai),改一处两边同时生效;本地测试可用 NB_AI_URL=http://localhost 覆盖。

装完只有一个命令 nb,不再需要记多个名字:

nb --help
nb init
nb app.js -m "首次部署"

装牛逼脚本会把二进制装到 ~/.local/bin(root 且可写时用 /usr/local/bin;Windows 是 %LOCALAPPDATA%\Programs\nb)并加入 PATH。提示找不到命令时新开一个终端,或手动 export PATH="$HOME/.local/bin:$PATH"。只装 nb 一个命令。

也可以先下载再执行:

curl.exe -fsSL https://nbjs.ai/nb.sh -o nb.sh
bash nb.sh

装完用 nb --help 确认。平台数据默认在 ~/.nb,可用进程环境变量 NB_HOME 改到其他目录。

1. 第一个脚本:不部署。新建一个普通 JS 脚本 hello.js:

// hello.js
console.log("hello from NBJS");

运行 nb hello.js。入口没有导出 fetch,所以只执行一次,不会部署;console.log 会打印出来,对 app.db 和 files/ 的写入仍然会保留。

2. 第一个应用:初始化并部署到本地。

mkdir demo
cd demo
nb init
nb app.js -m "首次部署"

nb init 会生成 app.js、nb.toml 和 package.json,入口大致是:

export default {
  async fetch() {
    return new Response("hello from NBJS");
  },
};

入口导出 fetch 时,平台探测通过后提交为正式应用,打开 http://demo.localhost/ 即可。本地部署不需要登录,数据在本机 ~/.nb/apps/demo。

3. 登录本地控制台(可选)。

nb login
nb app.js -m "登录后重新部署"

nb login 会打开 http://localhost/ 用邮箱登录,然后重新运行一次部署,应用就会出现在控制台列表里。不登录也能通过 http://demo.localhost/ 预览,只是控制台看不到;登录后重新部署即可。

4. 登录远程并部署:官方 nbjs.ai。

nb login -r you@example.com
nb app.js -r -m "首次上线"

远程部署必须先登录;-r 是官方远程模式,目标默认是 https://nbjs.ai,可用 NB_REMOTE 覆盖。

部署完成后到 https://nbjs.ai 控制台查看应用、版本、日志、数据库和 MQTT。本地与远程是两套数据,互不相通。

nb whoami -r            # 查看远程账号
nb logout -r            # 退出远程登录
nb app.js -r -m "说明"  # 部署并记录版本说明(建议每次部署都带)

命令 nb

安装后只有一个 nb 命令

安装后只需要记住 nb 一个命令:

nb --help
nb apps
nb app.js -m "首次部署"

安装脚本只安装 nb 一个命令,不再生成或维护其他别名。

运行方式

脚本、服务、工程化与远程

nb 目前有五种运行方式,区别在于入口是否导出 fetch,以及是本机还是远程。

  • 启动服务:nb 启动总服务,监听端口并按 Host 路由应用。服务未启动时,下面的本地命令会自动拉起它。
  • 脚本模式:nb sql.js 执行一次脚本,不导出 fetch 时不部署,只保留对 app.db 和 files/ 的写入。适合迁移、清理、批处理。
  • 服务模式:nb app.js -m "说明" 执行入口;入口导出带 fetch 的对象时,探测通过后提交为正式应用,域名请求进入 fetch。
  • 工程化入口:nb app.ts -m "说明" 先用内置 esbuild 打包 TS/JSX、多文件或 npm 依赖,再按脚本或服务模式处理。
  • 远程部署:nb app.js -r -m "说明" 打包后提交到官方 nbjs.ai,必须先 nb login -r。
nb                     # 启动总服务
nb sql.js              # 脚本模式,写操作保留
nb app.js -m "说明"    # 服务模式,导出 fetch 时部署并记录说明
nb app.ts -m "说明"    # 工程化入口,自动打包
nb app.js -r -m "说明" # 远程部署到官方平台

nb run sql.js 与 nb sql.js 等价,run 可以省略。所有 nb <file> 都在 ~/.nb/apps/<name>/ 沙箱里执行,权限来自该目录的 nb.toml;源码目录只参与打包。

常用参数:

nb app.js --name demo     # 指定应用名
nb app.js -p 3000         # 指定端口
nb app.js -m "说明"       # 保存版本说明(建议每次部署都带)
nb app.js --keep-static   # 只更新代码与配置,保留静态资源

项目模板

nb init 生成项目,phone_server 上传走 S3

nb init 支持 native、hono、arpc、arpc_new、shop、cms、formx、ai、phone_server、app:

nb init phone_server ./phone
cd phone
nb i
nb app.ts -m "说明"

nb i 用内置安装器安装 dependencies,不需要 Node;工程化入口由内置 esbuild 打包成单文件后部署。

phone_server 的图片、视频和后台收款码全部写入 S3:[fs] read/write = false,[s3] read/write = true。部署前必须在平台全局 ~/.nb/nb.toml 配好 [s3] 凭证,否则上传会报错。

版本与日志

history、rollback、source、logs

每次成功部署都会生成版本,默认保留最近 14 个;app.db 与 files/ 不参与回退。

部署时带 -m "说明" 会给版本写上说明,nb history 里能直接看到;建议养成每次部署都带的习惯。

nb history demo
nb rollback demo 3
nb source demo 3 --out ./demo-src
nb logs demo --limit 100

nb source 支持 --archive 打包 tar.gz,或 --bundle 导出已部署的单文件。

数据库与文件

db、files 命令直接查看应用数据

查看数据库表结构和数据:

nb db demo
nb db demo --table item
nb db demo --exec64 "SELECT 1"

查看和读写应用文件:

nb files demo
nb files demo --root static
nb files demo --write64 note.txt --from ./note.txt
nb files demo --read64 note.txt --to ./note.txt

部署只覆盖代码与配置,不会动 app.db 和 files/。

fs 只读写本机应用目录,s3 是独立的对象存储命名空间,两者互不影响:

await fs.write("note.txt", "hi");
const text = await fs.file("note.txt").text();

await s3.write("avatar.png", bytes, { contentType: "image/png" });
const file = s3.file("avatar.png"); // 同步返回懒加载 File
await file.bytes();
await s3.exists("avatar.png");
await s3.stat("avatar.png");
await s3.list("photos/", 1000);
await s3.copy("avatar.png", "backup/avatar.png");
await s3.presign("avatar.png", { expires: 3600 });
await s3.delete("avatar.png");

应用要在 nb.toml 写 [s3] read = true / write = true;平台凭证只来自全局 nb.toml。

fs 固定本机,对象存储只能用 s3 命名空间。

域名

平台二级域名自动生效,自定义域名走 CNAME

平台分配的二级域名默认是 <应用名>.<平台域名>,不需要配置。

nb domain add demo demo.example.com
nb domain list demo
nb domain remove demo demo.example.com

自定义域名在 Cloudflare 添加 CNAME,指向平台 fallback 域名并开启代理;DNS 生效时间取决于 TTL。

MQTT

nb mqtt 输出凭证;应用和设备两条主题

启用 MQTT 后,应用目录的 nb.toml 写 [mqtt] enabled = true,然后运行:

nb mqtt demo

输出 broker 地址、用户名、密码和主题。约定只有两条:

  • 设备 → 应用:设备发布到 <app>,payload 带 deviceId。
  • 应用 → 设备:应用发布到 <app>/<deviceId>,设备订阅自己的主题。
mqtt.publish("d1", JSON.stringify({ cmd: "unlock" }));

mqtt: {
  message(payload) {
    const msg = JSON.parse(payload);
  }
}

设备 id 用长随机串,clientId 用 <app>-<deviceId>。完整示例见仓库 nb/examples/mqtt。

应用管理

列表、上线、下线、删除

nb apps
nb online demo
nb offline demo
nb remove demo

下线只写 .offline 标记,域名路由返回 503,代码、数据库和文件都保留;上线删除标记。删除不可恢复。

全局配置与 nb.toml

~/.nb/nb.toml、应用 nb.toml 与 deploy.toml

平台配置在 ~/.nb/nb.toml,进程环境变量优先:

[server]
port = 443
tls_cert = "/path/fullchain.pem"
tls_key = "/path/privkey.pem"
main_app = "ai"
threads = 2
inflight = 8

[mqtt]
enabled = true
host = "127.0.0.1"
port = 1883

[s3]
endpoint = "https://..."
bucket = "nb"
access_key = "..."
secret_key = "..."

应用配置在项目目录的 nb.toml:[app]、[sql]、[fs]、[s3]、[net]、[static]、[ws]、[mqtt]、[limits]、[config]。平台级限制只能收紧,不能放宽。

定时任务写在应用导出的 cron 里:key 是 cron 表达式,value 是函数或函数数组,不需要配置。

控制台远程部署把 ai/deploy.toml 作为最终模板整体覆盖租户配置;模板默认关闭 proc、[s3]、[mqtt] 与 eval/Function/WASM,只保留本机 files/、SQL、出站 fetch、静态资源和受限 WS。平台全局 nb.toml 仍是所有上限的硬约束。

全局段包括 [server]、[backup]、[usage]、[static]、[sql]、[ws]、[mqtt]、[s3]、[jwt],进程环境变量优先于同名项。NB_HOME 必须作为进程环境变量设置。

AI 网关

文本、图片、语音、视频与计费

ai 是平台 AI 网关,创作页在 agent。网关统一暴露:

POST /v1/chat/completions
POST /v1/images/generations
POST /v1/audio/speech
POST /v1/audio/transcriptions
POST /v1/videos/generations
GET  /v1/tasks/:id
GET  /v1/models
GET  /v1/rates
POST /mcp

TTS 传 srt=true 返回音频 URL 和 SRT 字幕;不传直接返回音频字节。ASR 支持公网 URL、base64 或 multipart 上传,传 srt=true 时额外返回带时间轴的字幕。

应用调用不需要接触 DeepSeek / 百炼私钥。控制台远程部署会把当前用户的凭证写进 nb.toml:

const base = nb.config.ai_url;
const key = nb.config.ai_key;
await fetch(base + "/v1/chat/completions", {
  method: "POST",
  headers: { authorization: "Bearer " + key, "content-type": "application/json" },
  body: JSON.stringify({ messages: [{ role: "user", content: "你好" }] }),
});

计费单价在 ai/nb.toml 的 [config.rates],文本按 token、图片按张、TTS 按字符、ASR 按分钟、视频按秒;余额不足返回 402。

Office MCP

PPT、Excel、Word、PDF 与文件管理

office 通过 /mcp 提供文档工具,agent 的默认 MCP 已包含 NB Office:

  • ppt_create:标题页 + 内容页,支持要点、备注、主题。
  • xlsx_create:一个或多个工作表,传二维数组。
  • docx_create:标题、段落、小标题、要点列表。
  • pdf_create:英文 PDF 自动分页;中文请用 Word/PPT。
  • pdf_merge:合并本账号文件或公网 PDF。
  • file_list / file_delete:管理已生成文件。

文件按登录邮箱存放在 files/<userKey>/,只能本人下载。打开 office.<平台域名> 可以查看和下载已生成的文件。