@ciklumrnd/ciklum-cli/README.md

Ciklum CLI tool for internal engineering teams

# Ciklum CLI

Ciklum CLI tool for internal engineering teams.

## Installation

### Global Installation (Recommended)
```bash
npm install -g @ciklumrnd/ciklum-cli
```

### Using npx (without installation)
```bash
npx @ciklumrnd/ciklum-cli [command]
# Example:
npx @ciklumrnd/ciklum-cli accelerate mcp
```

### Local Development Setup

1. Clone the repository
2. Install dependencies:
   ```bash
   npm install
   ```

## Development and Testing

### Local Testing Methods

#### Method 1: Direct Development Mode (Recommended for development)
```bash
npm run dev -- [command] [options]
# Examples:
npm run dev -- --help
npm run dev -- accelerate mcp
```

#### Method 2: Build and Test Locally
```bash
npm run test:local -- [command] [options]
# Examples:
npm run test:local -- --help
npm run test:local -- accelerate mcp
```

#### Method 3: NPM Link (Simulates global installation)
```bash
# Link the package globally (one-time setup)
npm run link:local

# Now you can use 'ciklum' command globally
ciklum --help
ciklum accelerate mcp

# To unlink when done testing
npm run unlink:local
```

### Available Scripts

- `npm run build` - Compile TypeScript to JavaScript
- `npm run clean` - Remove built files
- `npm run dev` - Run CLI in development mode (with TypeScript support)
- `npm run test:local` - Build and run CLI locally
- `npm run link:local` - Build and link globally for testing
- `npm run unlink:local` - Remove global link

## Usage

```bash
ciklum [COMMAND]

# Show help
ciklum --help

# Show version
ciklum --version

# Create a new project from template
ciklum accelerate <template>
```

## Commands

### accelerate
Create new projects from templates.

```bash
ciklum accelerate mcp
```

## Development Notes

- The CLI is built with [oclif](https://oclif.io/) framework
- TypeScript is used for development
- Commands are located in `src/commands/`
- The compiled JavaScript goes to `lib/`