@tulipes/cli
v0.1.1
Published
The tulipes command line: scaffold, sync, inspect, describe and run Tulipes apps
Maintainers
Readme
@tulipes/cli
The tulipes command line for Tulipes
apps: scaffold, sync generated types, validate the environment, inspect routes,
generate OpenAPI/Postman documents, run in watch mode, add modules and upgrade.
It is separate from the runtime on purpose — a running app installs
@tulipes/core alone, without this package, its templates or the TypeScript
loader it carries.
npm install -g @tulipes/cli@next
tulipes init my-api # minimal preset; --preset production for the full app
cd my-api && corepack enable && yarn install && yarn devGenerated apps also list @tulipes/cli in devDependencies, so yarn dev,
yarn sync, yarn spec and yarn tulipes new module <name> work without a
global install and always match the app.
| Command | What it does |
|---|---|
| tulipes init [dir] [--minimal \| --preset minimal \| --preset production] [--no-queues] [--no-sockets] | scaffold an application; no services. The two opt-outs apply to the production preset and leave that provider, its files, dependencies and worker process out |
| tulipes dev [entry] | regenerate types, then run under tsx watch |
| tulipes sync | regenerate types/config.d.ts and .env.example |
| tulipes env:check | validate the environment without booting |
| tulipes routes [--offline \| --runtime] | list declared endpoints |
| tulipes spec [--offline \| --runtime] [--openapi file] [--postman file] [--url base] | generate documents (needs @tulipes/spec in the app) |
| tulipes new module <name> [--model\|--no-model] [--queues\|--no-queues] [--sockets\|--no-sockets] | scaffold a module for the providers the app declares |
| tulipes update | upgrade the global CLI and, inside an app, its core and CLI ranges |
| tulipes -v | print the CLI version, its bundled core, and the app's core when they differ |
Every command that touches an app boots or inspects it through the app's
own @tulipes/core, so there is one copy of every framework singleton; the
bundled core is only a fallback for directories with no install. Generated
dependency ranges follow the core this CLI bundles.
Versions
0.1.1 bundles core 0.10.1 and scaffolds for it. See core's
MIGRATING.md.
