create-frogbot-app
v0.42.0
Published
Scaffold a new FrogBot app.
Readme
create-frogbot-app
Create a new FrogBot app: a Next.js project with an AI agent, chat, an admin panel, and a database, ready to run.
npx create-frogbot-app@latest my-frogbotThe command asks a few questions, installs dependencies, and then sets up Git, so the first commit includes the lockfile. Then start the app:
cd my-frogbot
npm run devOpen http://localhost:3000 and create your admin account. The dashboard lists your collections; open Chats in the sidebar and select Create New to talk to your agent.
See Installation for a prompt that lets Claude Code, Cursor, Codex, or OpenCode set up the app for you, and Coding agents for skill installation options.
Usage
npx create-frogbot-app@latest [project-name] [options]| Option | Description |
| --------------------------- | ---------------------------------------------------------------- |
| -n, --name <name> | Project name |
| -t, --template <template> | blank or projects (default: blank) |
| -d, --db <database> | sqlite, postgres, or mongodb |
| --ai <provider> | zen, openai, anthropic, google, bedrock, or none |
| --api-key <key> | API key for the chosen provider (written to .env) |
| --agents <targets> | Comma-separated claude, codex, cursor, opencode, copilot, gemini |
| --no-agents | Do not install coding-agent skills |
| --use-npm | Use npm |
| --use-pnpm | Use pnpm |
| --use-yarn | Use yarn |
| --use-bun | Use bun |
| --no-git | Do not initialize git |
| --no-install | Do not install dependencies |
| --no-deps | Alias for --no-install |
| -y, --yes | Accept defaults without prompts |
| -h, --help | Show help |
Pass the project name once, either as the first argument or with --name.
Defaults
| Setting | Default |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Template | blank |
| Database | SQLite |
| AI provider | None (no AI provider, agents, or chat) |
| Package manager | The one that ran the command (npm when you use npx) |
| Git | A new repository whose initial commit includes the lockfile, unless the folder is already inside a Git or Mercurial repository |
| Dependencies | Installed |
| Coding agents | None |
Run without prompts
The questions appear only in an interactive terminal. With --yes, or when no terminal is attached (for example in CI or when a coding agent runs the command), every unset choice uses its default and the project name is required:
npx create-frogbot-app@latest my-frogbot --yes --agents codexPass --ai <provider> to set up a provider, and its key with --api-key to write it to .env. Without prompts, a key already set in your environment (such as OPENAI_API_KEY) is not copied into the app; the scaffolder says so and reminds you to add the key to .env. In an interactive terminal, it asks whether to use that key for the app instead.
Project names use lowercase letters, numbers, dots, dashes, and underscores, and start with a letter or number. The name is also the folder the project is created in, inside the current directory.
What gets created
- The app, with
src/frogbot.config.tsconfiguring the database, the AI provider, and two agents (generalandassistant), unless you choose no AI provider. .envwith a generatedFROGBOT_SECRET, the database URL, and the provider key line (filled in if you gave a key). Git ignores this file..env.examplewith the same variable names and no secrets.- For each coding agent you choose, the FrogBot skill and an instruction file that points to it:
| --agents value | Skill directory | Instruction file |
| ----------------------------- | ------------------------- | --------------------------------- |
| claude | .claude/skills/frogbot/ | CLAUDE.md |
| codex, cursor, opencode | .agents/skills/frogbot/ | AGENTS.md |
| copilot | .agents/skills/frogbot/ | .github/copilot-instructions.md |
| gemini | .agents/skills/frogbot/ | GEMINI.md |
See Coding agents for other ways to install the skill.
Troubleshooting
| Message | What to do |
| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Directory "<name>" already exists. | Choose another project name, or remove the existing folder. |
| A project name is required. Pass --name <name>. | Pass a name as the first argument or with --name. This happens with --yes or without a terminal. |
| Provide the project name once, either positionally or with --name. | Pass one name without spaces, either as the first argument or with --name, not both. |
| Invalid project name "<name>". Use lowercase letters, numbers, … | Use lowercase letters, numbers, dots, dashes, or underscores, starting with a letter or number. |
| Set <KEY_NAME> in <name>/.env before chatting. | The app starts without a key, but chat and other AI features fail until you add it to .env. The Bedrock message also offers AWS_PROFILE. |
| Found <KEY_NAME> in your environment but did not copy it to <name>/.env. … | The key works only in terminals where it is set. Add it to .env so the app always has it. |
| <package-manager> install failed. Git was not initialized. … | Fix the error shown above it and run the install command in the project folder. Git runs after the install, so set up the repository yourself. |
| FrogBot skill is not bundled in this build; run npx skills add frogbotai/frogbot. | Run npx skills add frogbotai/frogbot inside the project folder. |
Errors print one line that starts with [create-frogbot-app] error:, and the command exits with status 1. A longer report with a stack trace means an unexpected problem; please open an issue.
FrogBot needs Node.js 24.22.3 or newer. Once the app runs, a key set in your shell takes priority over the one in .env.
