create-gainiq

create-gainiq

CLI tool to set up the GAIN IQ development environment with all required dependencies and configurations.

Features

• ✅ Automatic Dependency Management

  • Node.js (latest LTS)
  • pnpm (v8.0.0+)
  • Turborepo CLI (v2.5.8+)
  • Prisma CLI (latest)

• ✅ Repository Setup

  • Clone GAIN IQ repository
  • Environment configuration
  • Full project setup

• ✅ Developer Experience

  • Interactive prompts
  • Progress indicators
  • Automatic VS Code integration

Usage

Run directly with npx (no installation required):

npx create-gainiq@latest

Or install globally:

npm install -g create-gainiq
create-gainiq

What It Does

• Checks and installs dependencies:

  • Node.js - Checks if installed, upgrades to latest LTS if needed
  • pnpm - Ensures version 8.0.0 or higher
  • Turborepo - Ensures version 2.5.8 or higher
  • Prisma CLI - Installs latest version

• Verifies GitHub access:

  • Checks if Git is installed
  • Checks if GitHub CLI (gh) is installed (optional but recommended)
  • Authenticates with GitHub if needed
  • Verifies you have access to the GAIN IQ repository

• Sets up the repository:

  • Clones the GAIN IQ repository
  • Prompts for installation location
  • Handles existing directories
  • Copies your .env.local file

• Runs project setup:

  • Executes pnpm setup:full
  • Installs all dependencies
  • Sets up database schemas

• Opens VS Code:

  • Optionally opens the project in VS Code

Requirements

• Operating System: macOS, Linux, or Windows
• Git: Must be installed
• GitHub Access: Must have access to the GAIN-OS/gain-iq repository
• GitHub CLI (optional): Recommended for easier authentication (installed automatically on macOS)
• Administrator Access: Required for global package installations

Prerequisites

Before running, make sure you have:

• GitHub Access

  • You have been granted access to the GAIN-OS/gain-iq repository
  • If you don't have access yet, contact the repository owner

• Environment File

  • A .env.local file with your configuration
  • The path to this file ready (you'll be prompted during setup)

Development

Build

npm run build

Development Mode

npm run dev

Test Locally

npm run build
npm link
create-gainiq

Architecture

src/
├── index.ts              # CLI entry point
├── commands/
│   └── setup.ts          # Main setup workflow
├── checks/
│   ├── node.ts           # Node.js check/install
│   ├── pnpm.ts           # pnpm check/install
│   ├── turborepo.ts      # Turborepo check/install
│   ├── prisma.ts         # Prisma check/install
│   └── github.ts         # Git and GitHub CLI check/auth
└── utils/
    ├── logger.ts         # Colored logging
    └── exec.ts           # Command execution utilities

Dependencies

• chalk - Terminal styling
• commander - CLI framework
• ora - Loading spinners
• prompts - Interactive prompts
• semver - Version comparison
• execa - Command execution
• node-fetch - HTTP requests

Troubleshooting

Git Not Found

If Git is not installed, download and install it:

• macOS: brew install git or download from git-scm.com
• Linux: Use your package manager (e.g., sudo apt-get install git)
• Windows: Download from git-scm.com

GitHub Authentication Failed

If GitHub authentication fails:

• Using GitHub CLI (recommended):

  gh auth login
  

  Follow the prompts to authenticate via web browser

• Manual authentication:

  • Generate a Personal Access Token at https://github.com/settings/tokens
  • Use the token when prompted for a password during git clone

• SSH authentication:

  • Set up SSH keys: https://docs.github.com/en/authentication/connecting-to-github-with-ssh
  • The CLI will use your SSH credentials automatically

Repository Access Denied

If you see "Cannot access repository":

• Make sure you've been granted access to the GAIN-OS/gain-iq repository
• Contact the repository owner to request access
• Verify you're authenticated with the correct GitHub account: gh auth status

Node.js Installation

If Node.js installation fails, install nvm first:

macOS/Linux:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

Windows: Download from nvm-windows

Permission Errors

Run with sudo access when prompted:

sudo npx create-gainiq@latest

VS Code Not Opening

Ensure code command is in your PATH:

# Add to ~/.zshrc or ~/.bashrc
export PATH="$PATH:/Applications/Visual Studio Code.app/Contents/Resources/app/bin"

License

MIT

Support

For issues or questions:

• GitHub: GAIN-OS/gain-iq
• Documentation: docs.gain-iq.com