StartXKit docs
CLI

info

Print the current StartXKit project configuration.

The info command prints the values from startxkit.config.json.

Use it when you want to quickly confirm which framework, architecture, API prefix, and validation option a project uses.

Usage

npx @startxkit/cli info

Run it from the generated project root.

Example Output

StartXKit 0.1.5
Framework: express
Language: typescript
Architecture: layered
Module directory: src
API prefix: /api/v1
Validation: zod
Auth: disabled
Database: disabled
ORM: disabled

Fields

FieldMeaning
FrameworkThe HTTP framework used by the project
LanguageThe generated language, currently TypeScript
ArchitectureThe folder layout strategy
Module directoryThe root used by module generation
API prefixThe global prefix before generated routes
ValidationThe selected validation library
AuthReserved for future auth support
DatabaseReserved for future database support
ORMReserved for future ORM support

Why It Matters

add module uses these values to decide where files should be written. If the info output says architecture: layered, new modules will be written into layer folders such as src/routes and src/controllers.