chore: prepare first release 1.0.1
Some checks failed
Code Quality / lint-and-build (push) Failing after 25s
Release Packages / release (push) Failing after 40s

This commit is contained in:
2026-02-01 01:01:16 +01:00
parent 9a0900e3ff
commit c0a739867f
23 changed files with 432 additions and 217 deletions

View File

@@ -1,26 +1,33 @@
# @mintel/cli
CLI tool for managing the Mintel monorepo and scaffolding new client websites.
The Mintel CLI is the primary automation tool for managing the monorepo and ensuring all client websites follow the same high-quality standards and infrastructure patterns.
## Installation
## 🚀 Installation
The CLI is intended to be used within the monorepo:
```bash
pnpm install
```
## Commands
## 🛠 Commands
### `init <path>`
Initializes a new website project in the specified path (relative to the monorepo root).
Scaffolds a new, production-ready client website in the specified path.
```bash
pnpm --filter @mintel/cli start init apps/my-new-website
pnpm --filter @mintel/cli start init apps/my-new-website.com
```
This command will:
1. Create the project directory.
2. Generate `package.json`, `tsconfig.json`, and `eslint.config.mjs` extending `@mintel` defaults.
3. Set up a localized Next.js structure (`src/app/[locale]`).
4. Configure `next-intl` middleware and request config.
5. Inject production-ready `Dockerfile`, `docker-compose.yml`, and Gitea Actions deployment workflows.
#### What it does:
1. **Project Structure**: Creates a modern Next.js directory layout.
2. **Shared Configs**: Generates `package.json`, `tsconfig.json`, and `eslint.config.mjs` that extend the `@mintel` shared packages.
3. **Localization**: Sets up a localized routing structure (`src/app/[locale]`) with `next-intl` pre-configured.
4. **Error Tracking**: Injects Sentry/GlitchTip instrumentation.
5. **Environment Safety**: Adds a validation script (`scripts/validate-env.ts`) to catch missing secrets at build time.
6. **Infrastructure**: Injects the universal `Dockerfile`, `docker-compose.yml`, and the tag-based Gitea Actions deployment workflow.
## 🛠 Development
To add new features to the scaffold (e.g., new shared files or config templates), modify `packages/cli/src/index.ts`.