综合介绍
Srcbook是一个以TypeScript为核心的应用开发平台,旨在通过AI助手快速创建和迭代Web应用。它支持本地运行,提供交互式笔记本界面,允许用户编写和执行后端代码。Srcbook是开源的,运行在本地机器上,用户需要自备API密钥以使用AI功能。
在专注构建前端界的AI编程工具中,Srcbook 对比 v0.dev 、Bolt 、Blackbox 在构建结构复杂的前端项目以及持续多轮对话迭代时更具优势。
Srcbook 演示地址和开源版功能不对等,开源版工具包含更完整的应用构建功能和笔记功能。Srcbook 官方推荐claude-3-5-sonnet-latest模型。可使用免费提供的 Grok模型 替代。
功能列表
- 应用构建器:AI应用构建器,支持TypeScript,创建、编辑和运行Web应用。
- 笔记本:创建、运行和分享TypeScript笔记本,支持导出为有效的Markdown格式(.src.md)。
- AI功能:生成样板代码、修改代码、修复问题,支持热重载Web预览。
- 本地执行:通过Web界面进行本地执行,支持Node.js。
- 图表绘制:使用Mermaid进行丰富的注释和图表绘制。
使用帮助
安装流程
- 环境要求:确保已安装Node.js 18+版本,建议使用nvm管理本地Node版本。
- 一键安装Srcbook:
- 使用npx运行最新版本:
bash
npx srcbook@latest start
- 或者全局安装:
bash
npm install -g srcbook
srcbook start
- 使用npx运行最新版本:
使用指南
- 启动Srcbook:在终端中运行
srcbook start
命令,启动Srcbook服务器。 - 创建新项目:
- 打开浏览器访问
http://localhost:3000
,进入Srcbook的Web界面。 - 使用AI助手生成初始代码模板,或手动编写TypeScript代码。
- 打开浏览器访问
- 编辑和预览:
- 在Web界面中编辑代码,实时预览修改效果。
- 使用热重载功能,无需手动刷新页面。
- 使用交互式笔记本:
- 创建新的TypeScript笔记本,编写和执行代码段。
- 导出笔记本为Markdown格式,方便分享和版本控制。
- 图表和注释:
- 使用Mermaid语法在笔记本中绘制图表和注释,增强代码可读性。
- 管理项目:
- 使用本地文件夹管理项目,确保代码和数据的安全。
- 定期备份和版本控制,避免数据丢失。
特色功能操作流程
- AI生成代码:
- 在编辑器中输入需求描述,AI助手将生成相应的代码模板。
- 根据提示修改和完善代码,AI助手会提供实时建议和错误修复。
- 实时预览:
- 每次保存代码修改,实时预览窗口将自动更新,显示最新效果。
- 使用热重载功能,无需手动刷新页面,提升开发效率。
- 交互式笔记本:
- 在笔记本界面中编写TypeScript代码段,点击运行按钮执行代码。
- 使用Markdown语法记录笔记和注释,导出为Markdown文件,方便分享和协作。
卸载流程
- 移除包:在命令行中输入
npm uninstall -g srcbook
或使用相应包管理器的卸载命令。 - 清理本地目录:删除本地配置目录
~/.srcbook
。
禁用分析和跟踪
为了改进Srcbook,我们会收集一些行为分析数据,但不会收集任何个人身份信息(PII)。如果您希望禁用跟踪,可以在环境中设置SRCBOOK_DISABLE_ANALYTICS=true
。