@gmoonc/cli

CLI do Goalmoon Ctrl (gmoonc): install and configure @gmoonc/app in React projects.

Installation

npm install @gmoonc/cli

Usage

Run the default command to install and configure @gmoonc/app:

npx gmoonc

The default command will:

1. Detect your project: Verify package.json exists and identify package manager (npm/pnpm/yarn)
2. Install dependencies: Add @gmoonc/app@^0.0.2 (which includes @gmoonc/ui and @gmoonc/core) and react-router-dom@^6.0.0 if needed
3. Find entrypoint: Look for src/main.tsx, src/main.jsx, src/main.ts or src/main.js
4. Inject CSS: Add CSS imports to your entrypoint:

   import "@gmoonc/ui/styles.css";
   import "@gmoonc/app/styles.css";

5. Integrate routes: Automatically detect and patch React Router:
   • Data Router (createBrowserRouter): Adds ...createGmooncRoutes({ basePath }) to router array
   • BrowserRouter: Adds <GmooncRoutes basePath="..." /> as first child of <Routes>

Options

• --yes / -y: Skip confirmations and install automatically
• --base <path>: Base path for dashboard routes (default: /app)
• --skip-router-patch: Skip automatic router integration (only install and inject CSS)
• --dry-run: Show what would be done without making changes

Examples

# Default setup with base path /app
npx gmoonc

# Custom base path
npx gmoonc --base /dashboard

# Skip router integration
npx gmoonc --skip-router-patch

# Dry run (see what would be done)
npx gmoonc --dry-run

# Skip confirmations
npx gmoonc --yes

Manual Integration

If automatic router integration is not possible, the CLI will print minimal instructions:

For Data Router (createBrowserRouter):

• Import createGmooncRoutes from @gmoonc/app
• Add ...createGmooncRoutes({ basePath: "/app" }) to your router array

For BrowserRouter:

• Import GmooncRoutes from @gmoonc/app
• Add <GmooncRoutes basePath="/app" /> as the first child of <Routes>

Always ensure CSS imports are present in your entrypoint:

• import "@gmoonc/ui/styles.css";
• import "@gmoonc/app/styles.css";

Requirements

• Node.js 18+
• Existing React project with package.json
• Entrypoint in src/main.* (tsx, jsx, ts or js)

Security

• Existing files are automatically backed up before modification
• Backup format: file.gmoonc.bak-YYYYMMDDTHHMMSS.ext
• CSS imports are not duplicated if they already exist

Site

https://gmoonc.com