@signalor/cli

Zero-config bootstrap for @signalor/nextjs. Drops middleware, llms.txt route, sitemap, postbuild hook, and your API key into an existing Next.js app in 30 seconds.

Quick start

Inside your Next.js project's root directory:

npx @signalor/cli init

That's it. The CLI will:

1. Detect your project (Next.js + package manager).
2. Ask for your Signalor API key (skippable — you can wire it later).
3. Install @signalor/nextjs using whichever package manager you use (pnpm / yarn / npm / bun).
4. Scaffold four files (never overwriting existing ones):
   • src/proxy.ts on Next.js 16+ / src/middleware.ts on 14-15 — AI-crawler detection
   • app/llms.txt/route.ts — auto-generated llms.txt
   • app/sitemap.ts — Signalor sitemap helper
   • patches package.json scripts.postbuild to run signalor-deploy
5. Write SIGNALOR_API_KEY to .env.local (if you provided a key).
6. Print a summary + manual next-steps for <SignalorSchema /> in your root layout.

What it won't do

• Overwrite existing files. If you already have proxy.ts/middleware.ts, app/llms.txt/route.ts, or app/sitemap.ts, the CLI leaves them alone and prints the snippet you should add manually.
• Touch your git state. No commits, no branches. Review the diff yourself.
• Run on non-Next.js apps. It bails out if next isn't in package.json.

Subcommands

| Command | What it does | | ------------------ | ---------------------------------------------- | | signalor init | Bootstrap @signalor/nextjs in this project | | signalor --help | Show usage | | signalor --version | Print the installed version |

More to come (signalor analyze, signalor login).

Get an API key

Mint one at signalor.ai → Settings → Developers. Per-org, revocable any time, shown once on creation.

License

MIT