create-instant-app 使用指南：用一条命令快速搭建 InstantDB 应用脚手架

后端数据库【免费下载链接】instantInstant is the best backend for AI-coded apps. You get auth, permissions, storage, presence, and streams — everything you need to ship apps your users will love.项目地址https://gitcode.com/gh_mirrors/inst/instant点击查看免费下载create-instant-app是 Instant 开源仓库中负责应用脚手架初始化的 CLI 工具它让你只需执行npx create-instant-app即可在交互式提示或命令行参数驱动下生成接入 InstantDBauth、权限、存储、presence、streams 等能力的前后端项目骨架。读完本文你将掌握该工具的全部用法交互式流程、常用参数、非交互式一键搭建、其脚手架实现原理本地模板 / tiged 拉取、规则文件注入、包管理器探测以及如何在本地开发和调试这个 CLI 本身。快速开始一条命令拉起 Instant 应用create-instant-app的使用方式与众多create-*脚手架一致无需预先安装任何全局依赖直接通过npx调用即可源码中通过package.json的bin字段暴露了create-instant-app命令见 package.json。npx create-instant-app运行后工具会依次向你提问项目/文件夹名称默认值为awesome-todos输入的名称会同时作为目录名与应用名cli.ts 中通过validateAppName校验仅允许小写字母、数字、-与_也支持.表示使用当前目录。选择框架模板默认Web: Next.js可切换为Mobile: Expo或展开次级选项选择 Vite React、Vite Vanilla TS、Tanstack Start、Bun React、SolidJS、SvelteKit、Vite Vue、Vercel AI SDK 等更多模板。为哪种 AI 工具生成规则文件可选 Claude、Cursor、Codex、Gemini、Zed、Windsurf 或 None默认 Claude。连接/创建 InstantDB 应用若未登录可选择登录账户、创建临时应用有效期两周或稍后创建。完成这些步骤后工具会自动拉取模板、安装依赖自动探测 npm/pnpm/yarn/bun、初始化 git 仓库默认开启并把生成的APP_ID/ admin token 写入.env文件随后打印下一步命令通常是cd dir然后pnpm run dev之类整个项目即可运行。常用命令行参数速查除了纯交互模式CLI 还提供了大量参数用于跳过提问、指定模板和连接已有应用。以下参数均定义于 cli.ts命令版本号直接复用instantdb/version包--version输出。参数说明备注[dir]应用名称同时也是要创建的目录名作为第一个位置参数传入-b, --base template指定基础模板可选值见下方可用模板列表-g, --git在新项目中创建 git 仓库默认开启--no-git不创建 git 仓库--expo使用 Expo 起步模板等价于-b expo--next使用 Next.js 起步模板等价于-b next-js-app-dir--vanilla使用 Vanilla JS 模板等价于-b vite-vanilla--vite-react使用 Vite React 模板等价于-b vite-react--sv使用 SvelteKit 模板等价于-b sveltekit--vue使用 Vue Vite 模板等价于-b vue-vite--python使用 Python 脚本模板等价于-b python-script--cursor/--claude/--codex/--gemini注入对应 AI 工具的规则文件见下文AI 规则文件--rules注入AGENTS.md规则文件等价于--codex--ai基于一段自然语言提示创建 InstantDB 应用需要本机已安装 Claude Code且会额外询问你想创建什么-a, --app app-id关联一个已存在的 InstantDB 应用需要登录或配合--token-t, --token token使用指定 admin token 关联应用与--app搭配用于未登录场景-y, --yes使用全部默认值跳过所有提问必须同时提供项目名且不能与--ai同用--temp默认创建一个临时应用不能与--app同用几个典型的非交互式用法示例# 使用默认 Next.js 模板、默认配置全自动创建 npx create-instant-app my-app --yes # 指定 Vite React 模板并注入 Cursor 规则文件 npx create-instant-app my-app --vite-react --cursor # 关联已有应用未登录时提供 token npx create-instant-app my-app --app app-id --token admin-token在--yes模式下工具会自动决定创建方式如果检测到已登录则创建真实应用否则创建一个临时ephemeral应用见 login.ts 中tryConnectApp的分支逻辑。临时应用有效期约两周之后可用npx instant-cli claim认领为正式应用。可用模板与对应环境变量create-instant-app内置的模板清单定义在 projectBase.ts共 13 种Web 框架类next-js-app-dir、vite-react、vite-vanilla、tanstack-start、tanstack-start-with-tanstack-query、sveltekit、vue-vite、solidjs-viteMobile 类expoAI 应用类vercel-ai-sdk、ai-chat其他bun-react、python-script每种模板都声明了自己的APP_ID环境变量名脚手架完成应用关联后会据此把凭据写入对应环境的.env文件模板环境变量名next-js-app-dir、vercel-ai-sdk、ai-chatNEXT_PUBLIC_INSTANT_APP_IDvite-react、vite-vanilla、tanstack-start、solidjs-vite、sveltekit、vue-viteVITE_INSTANT_APP_IDexpoEXPO_PUBLIC_INSTANT_APP_IDbun-reactBUN_PUBLIC_INSTANT_APP_IDpython-scriptINSTANT_APP_ID此外projectBase.ts还定义了每个模板的后端配置文件backend config普通前端模板只有一个客户端init配置src/lib/db.ts启用 websocket而tanstack-start、vercel-ai-sdk、ai-chat等模板还额外包含一个 admin 配置src/lib/adminDb.ts初始化为init或initAdmin不启用 websocket用于服务端管理操作。python-script模板则对应main.py中的 Python 后端配置。脚手架生成流程与底层原理了解完用法后再来看它内部究竟做了什么。入口是 index.ts整个流程如下解析参数与提问runCli()cli.ts用commander解析参数用clack/prompts渲染交互式提问支持INSTANT_CLI_API_URI/INSTANT_CLI_DASH_URI环境变量覆盖后端地址backendConfig.ts。拉取模板代码scaffoldBase()scaffold.ts按优先级选择三种方式dev设置了INSTANT_CLI_DEV与INSTANT_REPO_FOLDER时直接从本地仓库的examples/template目录复制遵循.gitignore规则见copyRespectingGitignorebundled-template若包内template/base/template目录存在则直接复制生产发布时模板随 npm 包分发同时会把_gitignore改回.gitignoretiged以上都不满足时用 tigeddegit 的维护分支以 tar 模式从instantdb/instant/examples/template拉取对应示例子目录。脚手架还会处理目录冲突空目录继续、非空目录询问中止或清空、删除多余的锁文件、为 Expo 追加.npmrcnode-linkerhoisted并把app.json与app/_layout.tsx中的模板占位名替换为你的应用名。注入 AI 规则文件addRuleFiles()ruleFiles.ts将 template/rules/AGENTS.md 复制到项目根目录文件名按所选 AI 工具映射Claude →CLAUDE.mdGemini →GEMINI.mdCursor / Codex / Zed / Windsurf →AGENTS.md。连接或创建应用tryConnectApp()login.ts根据登录状态与参数执行三种策略之一创建真实应用createPOST/dash/apps、导入已有应用import通过--app/--token或登录态校验访问权限、创建临时应用ephemeralPOST/dash/apps/ephemeral附带一套默认宽松的 permissions 规则。未登录时会弹出选择菜单选择登录则通过/dash/cli/auth/register获取 ticket 并打开浏览器完成授权轮询/dash/cli/auth/check等待结果最长约 120 秒。写凭据、装依赖、初始化 git把appId/adminToken写入.envapplyEnvFilePython 模板改写pyproject.toml的name字段其余模板更新package.json的name与packageManager字段随后自动执行包管理器安装installPackages.ts并在默认开启时git init。输出启动指引按模板类型打印下一步命令若使用了--ai还会调用 Claude Code 基于你的提示词在项目内继续生成应用逻辑claude.ts。值得注意的是包管理器自动探测逻辑getUserPkgManager.ts通过读取npm_config_user_agent环境变量判断你调用npx时使用的是 yarn、pnpm 还是 bun否则回退到 npm唯一例外是bun-react模板强制使用 bun。这意味着无论你惯用哪种工具链脚手架都会用同一套包管理器完成安装。应用名校验规则应用名需要同时满足 npm 包名规范校验逻辑在 validateAppName.ts/^(?:[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/即名称只能包含小写字母、数字、-、_与.可选支持 npm scope 前缀org/name形式。parseNameAndPath会从输入中拆分出 scoped 应用名与目录路径例如acme/todo-app会被解析为应用名acme/todo-app、目录todo-app传入.时则使用当前目录名作为应用名。无效名称会直接报错退出交互模式下则提示重新输入。本地开发与调试这个 CLI如果你想基于当前仓库修改或调试create-instant-app本身仓库提供了完整的开发工作流见 package.json# 安装依赖在仓库根目录执行 pnpm install 后 pnpm run build # 构建tsup 打包构建前会自动执行 copy-examples pnpm run dev # 开发模式tsup --watch 监听重建构建产物为dist/index.jspackage.json的exports与bin均指向它。开发时可通过pnpm link --global把当前包软链接到全局之后即可在任何目录直接使用create-instant-app命令等价于npx create-instant-app的本地版pnpm link --global create-instant-app # 任意目录下直接使用调试完成后解除链接pnpm uninstall create-instant-app --global本地开发时若希望跳过从 GitHub 拉取模板加快迭代、便于离线可以设置INSTANT_CLI_DEV与INSTANT_REPO_FOLDER指向仓库的 examples 目录脚手架便会直接从本地examples/template复制代码若只设置了INSTANT_CLI_DEV而未设置INSTANT_REPO_FOLDER工具会打印警告并回退到从远程拉取。仓库还提供了单元测试与端到端测试保障pnpm test、pnpm test:e2e其中 create-instant-app.e2e.test.ts 覆盖了从执行 CLI 到项目生成的完整链路是理解各参数实际行为的最佳参考。小结create-instant-app的价值在于把选模板 → 拉代码 → 配环境变量 → 关联/创建 InstantDB 应用 → 装依赖 → 初始化 git这一整套初始化动作收敛为一条命令日常使用只需npx create-instant-app跟随引导即可CI 或脚本化场景可使用--yes等参数全自动生成需要接入已有数据时用--app/--token关联而--ai模式则把脚手架与 Claude Code 结合实现一句话生成 InstantDB 应用。配合本文对 cli.ts、scaffold.ts、login.ts 等核心源码的拆解你既可以熟练使用它也可以在需要时对它进行本地开发和二次定制。赞分享后端数据库【免费下载链接】instantInstant is the best backend for AI-coded apps. You get auth, permissions, storage, presence, and streams — everything you need to ship apps your users will love.项目地址https://gitcode.com/gh_mirrors/inst/instant点击查看免费下载相关推荐使用 create-instant-app 快速搭建 Instant 应用脚手架指南与 CLI 全参数解析使用 create instant app 快速搭建 Instant 应用脚手架指南与 CLI 全参数解析 create instant app 是 Inst后端数据库create-quasar 脚手架实战指南一条命令从零搭建 Quasar 应用与 App Extensioncreate quasar 脚手架实战指南一条命令从零搭建 Quasar 应用与 App Extension 本指南以 Quasar 官方脚手架工具 crea前端UI组件跨平台InstantDB 与 Next.js App Router 实战用 create-instant-app 搭建实时 Todos 应用InstantDB 与 Next.js App Router 实战用 create instant app 搭建实时 Todos 应用 本篇指南围绕开源仓库后端数据库上一篇抖音平台反自动化检测的三层架构设计与突破方案下一篇抖音API突破实战5个核心技巧模拟真实浏览器行为创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考