Skip to main content

Basic usage

Direct CLI usage

You can also preselect starter components:
And choose the schema library for the generated tool example:

Arguments

Flags

Interactive flow

The current prompt flow asks for:
  • project name
  • package manager
  • schema library
  • starter components
  • transport
  • deploy target when the transport is HTTP

Generated files

Always generated:
  • .gitignore
  • README.md
  • package.json
  • tsconfig.json
  • src/index.ts
Generated starter code can include:
  • .tool(...)
  • .resource(...)
  • .prompt(...)
When tools are included, the generated example uses the selected schema library:
  • zod
  • json-schema
  • valibot
  • typebox
Generated for deploy presets:
  • Dockerfile / fly.toml (fly-io)
  • Dockerfile + Unkey README deploy commands (unkey)
  • vercel.json + api/index.ts (vercel)
  • wrangler.jsonc (cloudflare)