CLI
doctor
Run diagnostic checks on a generated StartXKit project.
The doctor command checks whether the current folder looks like a valid StartXKit project.
Use it when:
- You moved files manually
add modulefails- You are not sure which project configuration is active
- You want a quick sanity check before committing generated code
Usage
npx @startxkit/cli doctorRun it from the generated project root.
What It Checks
| Check | Meaning |
|---|---|
startxkit.config.json | The project has a StartXKit config file |
package.json | The folder is a Node.js project |
| Module directory | The configured module root exists |
| Framework | The framework is express, fastify, or hono |
| Architecture | The architecture is minimal, modular, or layered |
| Package manager | The package manager is pnpm, npm, yarn, or bun |
Example Output
✓ startxkit.config.json
✓ package.json
✓ module directory
✓ framework supported
✓ architecture supported
✓ package manager supportedModule Directory Meaning
The module directory depends on architecture:
| Architecture | Module directory |
|---|---|
| Minimal | src |
| Modular | src/modules |
| Layered | src |
This is intentional. Modular projects store each feature under src/modules, while layered projects write route/controller/service files into top-level layer folders under src.
If A Check Fails
Fix the reported file or config value, then run:
npx @startxkit/cli doctoragain.