Sykli Innovation Pipeline CLI

A CLI tool for scaffolding projects from GitHub templates stored in the private repository [email protected]:Neogrant-Oy/innovation-pipeline.git.

Installation

npm install -g sykli-innovation-pipeline

Or use with npx without installing globally:

npx sykli-innovation-pipeline@latest add nestjs

Setup

Authentication for Private Repository

Since this tool accesses a private GitHub repository, you need to set up authentication:

1. Create a GitHub Personal Access Token:

   • Go to GitHub Settings → Developer settings → Personal access tokens → Tokens (classic)
   • Click "Generate new token (classic)"
   • Select scopes: repo (Full control of private repositories)
   • Copy the generated token

2. Set the environment variable:

   export GITHUB_TOKEN=your_personal_access_token_here

   Or for Windows:

   set GITHUB_TOKEN=your_personal_access_token_here

   For permanent setup, add it to your shell profile (.bashrc, .zshrc, etc.) or environment variables.

Usage

Add a Template to Current Directory

# Add NestJS template to current directory
npx sykli-innovation-pipeline@latest add nestjs

# Add with options
npx sykli-innovation-pipeline@latest add nestjs --force --verbose

# Add to specific directory
npx sykli-innovation-pipeline@latest add nestjs --directory ./my-project

List Available Templates

npx sykli-innovation-pipeline@latest list

Interactive Project Creation

npx sykli-innovation-pipeline@latest create

Get Template Information

npx sykli-innovation-pipeline@latest info nestjs

Available Templates

The CLI tool fetches templates from the ci/ directory of the private repository:

• nestjs - A progressive Node.js framework for building scalable server-side applications
• react - A JavaScript library for building user interfaces
• vue - The progressive JavaScript framework

Command Options

Global Options

• --help, -h - Show help information
• --version, -V - Show version number

Add Command Options

• --force, -f - Overwrite existing files without confirmation
• --skip-install, -s - Skip automatic dependency installation
• --verbose, -v - Enable verbose logging
• --directory <dir>, -d - Target directory (default: current directory)

Examples

# Basic usage
npx sykli-innovation-pipeline@latest add nestjs

# Create new project in specific directory
npx sykli-innovation-pipeline@latest add nestjs --directory ./my-nestjs-app

# Skip dependency installation
npx sykli-innovation-pipeline@latest add react --skip-install

# Force overwrite existing files
npx sykli-innovation-pipeline@latest add vue --force

# Interactive creation
npx sykli-innovation-pipeline@latest create

Project Structure

After installation, your project will include:

• All files from the selected template in ci/<template-name>/
• Updated package.json with project-specific information
• Template variables replaced with actual values
• .sykli-meta.json with project metadata

Template Variables

Templates can include variables that will be replaced during installation:

• {{PROJECT_NAME}} - Name of the target directory
• {{TEMPLATE_NAME}} - Name of the template
• {{CREATED_DATE}} - Date of project creation

Troubleshooting

Authentication Issues

If you get authentication errors:

1. Verify your GitHub token is set: echo $GITHUB_TOKEN
2. Ensure the token has repo scope for private repositories
3. Check that your GitHub account has access to Neogrant-Oy/innovation-pipeline

Template Not Found

If a template is not found:

1. Run npx sykli-innovation-pipeline@latest list to see available templates
2. Verify the template exists in the ci/ directory of the repository
3. Check your internet connection and GitHub access

Network Issues

If you encounter network errors:

1. Check your internet connection
2. Verify GitHub is accessible
3. Try again after a few moments

Development

Building from Source

git clone <this-repository>
cd sykli-innovation-pipeline
yarn install
yarn build

Running in Development

yarn dev add nestjs

License

MIT