Skip to content
Junior

junior init

Use junior init when you want a new project to start from the supported runtime shape instead of wiring Junior by hand.

Usage

Section titled “Usage”
Terminal window
pnpm dlx @sentry/junior init my-bot

The command requires exactly one argument: the target directory.

What it creates

Section titled “What it creates”

The scaffold includes:

  • package.json with @sentry/junior, @sentry/junior-maintenance, @sentry/junior-memory, hono, nitro, typescript, jiti, and @types/node
  • pnpm-workspace.yaml with a 24-hour dependency release delay and an immediate exception for the @sentry/* package scope
  • plugins.ts with @sentry/junior-maintenance and createMemoryPlugin() enabled
  • server.ts
  • nitro.config.ts pointing at ./plugins
  • tsconfig.json extending Nitro’s TypeScript config
  • vercel.json
  • .github/workflows/ci.yml
  • app/SOUL.md
  • app/WORLD.md
  • app/DESCRIPTION.md
  • app/skills/
  • app/plugins/
  • .env.example
  • .gitignore

SOUL.md sets Junior’s default voice, WORLD.md holds operational context, and DESCRIPTION.md powers the user-facing app description. Add other app/*.md files only when you want optional reference material available to the agent at runtime. ABOUT.md is not part of the scaffold and is not supported.

The generated plugins.ts enables @sentry/junior-maintenance and createMemoryPlugin() by default. Maintenance provides the self-update skill for keeping Junior packages current, and memory provides long-term recall once you configure Postgres with pgvector. plugins.ts is also the place to add other packaged plugins later.

This gives you the supported app shape needed to run Junior locally, keep the app updated, and continue with plugin or skill setup.

Example output

Section titled “Example output”

After a successful run, the CLI prints the created path and the next command to run:

Created my-bot at /path/to/my-bot


  cd my-bot && pnpm install && pnpm dev

Constraints

Section titled “Constraints”

junior init is strict about the target path:

  • The path must be a directory, not a file
  • The directory must be empty if it already exists
  • Extra arguments are rejected

If validation fails, the CLI exits non-zero and prints an error such as:

junior command failed: refusing to initialize non-empty directory: /path/to/my-bot

Verification

Section titled “Verification”

After scaffolding:

  1. Run cd my-bot && pnpm install.
  2. Fill in the required values from .env.example, including DATABASE_URL.
  3. Run pnpm dev.
  4. Check http://localhost:3000/health.

For the complete setup flow, continue with Quickstart.

Next step

Section titled “Next step”

Follow Quickstart to add env vars, then run junior check once you start adding skills or plugins.