create-restforge-app

Scaffold a new RESTForge backend project — creates a project folder, installs @restforgejs/platform, and generates a default config/db<name>.env.

Usage

npx create-restforge-app@latest my-app

Scaffold into the current directory instead of creating a new one:

npx create-restforge-app@latest .

Skip all prompts and use defaults:

npx create-restforge-app@latest my-app --yes

Options

| Flag | Description | |---|---| | --yes, -y | Skip prompts, use default values | | --db=<type> | Database dialect: postgresql (default), mysql, oracle, sqlite |

Without --yes, the CLI also prompts for LICENSE, SERVER_ADDRESS, REST_API_PORT, and the database connection parameters (DB_TYPE, DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_NAME) — each with a dialect-aware default.

What it generates

my-app/
├── package.json
└── config/
    └── dbmy_app.env

DB_NAME defaults to db<project-name> (dashes become underscores), except for oracle which defaults to ORCL, and sqlite which uses a file path under ./data/.

License

MIT