在线应用构建器 · Discord · Youtube · Hub

维护者注

目前Srcbook并未处于积极开发状态。在大量用户要求将其转变为托管服务之后，我们已经构建并正在运营 https://getmocha.com 来实现这一目标！

未来，我们可能会重新启用Srcbook的笔记本产品（相较于应用构建器而言，后者更适合由Mocha来提供）。

Srcbook

Srcbook是一个以TypeScript为核心的应用开发平台，拥有两大主要产品：

• 一个AI应用构建器（也可通过在线托管使用）
• 一个TypeScript笔记本

Srcbook是开源的（Apache 2.0许可），可在您的本地机器上运行。您需要自行提供用于AI功能的API密钥（我们强烈推荐使用Anthropic的claude-3-5-sonnet-latest模型）。

功能

应用构建器

• 面向TypeScript的AI应用构建器
• 创建、编辑和运行Web应用
• 利用AI生成代码框架、修改代码并修复问题
• 借助热重载的Web预览界面编辑应用

笔记本

• 创建、运行和分享TypeScript笔记本
• 导出为有效的Markdown格式（.src.md）
• 提供AI功能，帮助探索和迭代想法
• 使用mermaid进行图表绘制，实现丰富的注释
• 在本地通过Web界面执行
• 基于Node.js运行

常见问题解答

请参阅常见问题解答。

开始使用

Srcbook作为带有Web界面的CLI应用程序，在您的本地机器上运行。

系统要求

• Node 18及以上版本，建议使用nvm来管理本地Node版本
• corepack用于管理包管理器版本

安装

我们建议使用npx始终运行来自npm的最新版本：

# 使用npm
npx srcbook@latest start

# 使用您对应的包管理器
pnpm dlx srcbook@latest start

您也可以选择全局安装，使用<包管理器> i -g srcbook 然后直接通过srcbook start来启动程序。

使用Docker

您也可以通过Docker运行Srcbook：

# 构建Docker镜像
docker build -t srcbook .

# 运行容器
# -p标志将容器内的2150端口映射到您的主机
# 第一个-v标志挂载您的本地`.srcbook`目录以持久化数据
# 第二个-v标志共享您的npm缓存以提升性能
docker run -p 2150:2150 -v ~/.srcbook:/root/.srcbook -v ~/.npm:/root/.npm srcbook

请确保在启动容器后设置您的API密钥。您可以通过http://localhost:2150的Web界面完成此操作。

当前命令

$ srcbook -h
用法：srcbook [选项] [命令]

Srcbook是一个面向TypeScript的交互式编程环境

选项：
  -V, --version                 输出版本号
  -h, --help                    显示命令帮助

命令：
  start [选项]               启动Srcbook服务器
  import [选项] <说明符>     导入笔记本
  help [命令]                显示命令帮助

卸载

您可以先移除软件包，再清理其在磁盘上的本地目录来卸载Srcbook：

rm -rf ~/.srcbook

# 如果您进行了全局安装
npm uninstall -g srcbook

如果您使用了其他包管理器，则需要使用其特定的卸载命令。

分析与追踪

为了改进Srcbook，我们会收集一些行为分析数据。我们不会收集任何个人身份信息（PII），我们的目标只是为了提升应用体验。由于代码是开源的，您无需信任我们，可以直接验证！更多信息请参阅我们的隐私政策。

如果您希望禁用追踪，可以在运行Srcbook时设置环境变量SRCBOOK_DISABLE_ANALYTICS=true。

贡献

有关开发说明，请参阅CONTRIBUTING.md。

Srcbook 快速上手指南

环境准备

系统要求

• 支持 macOS、Linux 和 Windows（通过 WSL）
• 需要 Node.js 18+，推荐使用 nvm 管理本地 Node 版本
• 需要 corepack 来管理包管理器版本

安装步骤

推荐使用 npx 直接运行最新版本：

# 使用 npm
npx srcbook@latest start

# 使用 pnpm
pnpm dlx srcbook@latest start

也可以全局安装：

# 全局安装（npm）
npm install -g srcbook

# 全局安装（pnpm）
pnpm add -g srcbook

然后直接运行：

srcbook start

Docker 安装（可选）

# 构建镜像
docker build -t srcbook .

# 运行容器
docker run -p 2150:2150 -v ~/.srcbook:/root/.srcbook -v ~/.npm:/root/.npm srcbook

启动后通过 http://localhost:2150 访问 Web 界面，并设置 API Key。

基本使用

启动后，您可以通过浏览器访问 http://localhost:2150，并使用以下命令进行操作：

• 创建或导入 Notebook
• 编辑和运行 TypeScript 代码
• 使用 AI 功能生成代码、修改逻辑等
• 导出为 Markdown 格式

示例：创建一个简单的 Notebook 并运行代码：

1. 在 Web 界面中点击 "New Notebook"
2. 输入以下代码：

   console.log("Hello, Srcbook!");
   

3. 点击运行按钮查看输出结果

注意：需要配置 AI API Key（推荐使用 Anthropic 的 claude-3-5-sonnet-latest）才能使用 AI 功能。