# TekGen CLI

Is a modern, interactive command-line tool that helps you quickly scaffold full-stack project templates in your favorite framework — **Angular, React, Vue, Express, NestJS, or Next.js** — complete with folder structure, ESLint, Jest, and CI configuration.

> Built for developers who want to spin up production-ready projects in seconds.

---

## Features

- Generate project skeletons for:
  - Angular 19+
  - React 18+
  - Vue 3+
  - Express.js
  - NestJS
  - Next.js 14+
- Flexible styling options:
  - Tailwind CSS
  - SCSS/Sass
  - Standard CSS
- Preconfigured testing setup (Jest)
- ESLint + Prettier ready
- GitHub Actions CI/CD templates
- Organized folder structure
- Fully interactive CLI using **Inquirer.js**
- Written in TypeScript, powered by **Oclif** and **Commander**

---

## Installation

### Global installation (recommended)

```bash
npm install -g tekgen-cli
```

Then verify the installation:

tekgen --version

Or run via npx

npx tekgen-cli new

Updating

To keep your TekGen CLI up to date with the latest features and bug fixes:

Check current version

tekgen --version

Update global installation

npm update -g tekgen-cli

Or reinstall latest version

npm install -g tekgen-cli@latest

Using other package managers

# Yarn
yarn global upgrade tekgen-cli

# pnpm
pnpm update -g tekgen-cli

Check latest available version

npm view tekgen-cli version

Troubleshooting Updates

If the standard update commands don't work, try a complete reinstall:

# Complete uninstall and reinstall
npm uninstall -g tekgen-cli
npm install -g tekgen-cli@latest
tekgen --version

This ensures you get the latest version by completely removing the old installation first.

Usage

Run the generator interactively:

tekgen new

You’ll be prompted to choose a framework:

? Which framework would you like to generate?
> Angular
  React
  Vue
  Express
  NestJS
  Next.js

After selecting, TekGen scaffolds your project with a ready-to-run setup:

project-name/
 ├── src/
 ├── tests/
 ├── .eslintrc.json
 ├── jest.config.js
 ├── package.json
 └── README.md

Then navigate into the folder and install dependencies:

cd project-name
npm install
npm run dev

Example Commands

| Command | Description | | -------------------------------- | -------------------------------------- | | tekgen new | Launch interactive generator | | tekgen new --framework angular | Generate a specific framework directly | | tekgen --help | View available commands | | tekgen --version | Display current CLI version |

Supported Templates

Each template includes:

• Sample folder structure
• ESLint + Prettier setup
• Jest config
• Example component/service/controller
• CI/CD YAML for GitHub Actions

Folder Structure

tekgen-cli/
 ├── src/
 │   ├── index.ts           # CLI entry file
 │   ├── commands/
 │   └── generators/
 │       ├── angular/
 │       │   ├── index.ts
 │       │   └── templates/
 │       ├── react/
 │       ├── vue/
 │       ├── express/
 │       ├── nestjs/
 │       └── nextjs/
 ├── dist/                  # Compiled output
 ├── package.json
 ├── tsconfig.json
 └── README.md

Testing Your CLI Locally

To test without publishing:

npm run build
npm link

Then run:

tekgen new

To unlink when done:

npm unlink -g tekgen-cli

Example Generated Project (Angular)

After running tekgen new and choosing Angular:

my-angular-app
 |   public/
 │   ├── assets/
 ├── src/
 │   ├── app/
 │   ├── environments/
 │   └── main.ts
 ├── angular.json
 ├── package.json
 ├── jest.config.js
 ├── .eslintrc.json
 ├── .gitignore
 └── README.md

Tech Stack

• Node.js (CLI runtime)
• TypeScript (core logic)
• Commander.js / Oclif (CLI framework)
• Inquirer.js (interactive prompts)
• Chalk (beautiful CLI colors)
• fs-extra & execa (file + process utilities)

Publishing to npm

If you’re maintaining your own fork:

npm login
npm version patch
npm publish --access public

Contributing

Contributions, ideas, and feedback are welcome!

1. Fork the repo

2. Create your feature branch:

   git checkout -b feature/amazing-feature

3. Commit your changes:

   git commit -m "Add amazing feature"

4. Push and open a Pull Request

� Contributing

We welcome contributions! Please see our Contributing Guide for details.

Quick Start for Contributors

1. Fork the repository
2. Clone your fork: git clone https://github.com/your-username/tekgen-cli.git
3. Install dependencies: npm install
4. Make your changes
5. Run tests: npm test
6. Build the project: npm run build
7. Submit a pull request

Development Setup

# Clone the repository
git clone https://github.com/abdulrashid232/tekgen-cli.git
cd tekgen-cli

# Install dependencies
npm install

# Build the project
npm run build

# Run tests
npm test

# Run locally
npm run dev

For detailed development instructions, see CONTRIBUTING.md.

Testing

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

# Run comprehensive test suite
npm run test:all

For detailed testing information, see TESTING.md.

Author

Abdul-Rashid Issah Takoradi, Ghana Contact GitHub Profile

License

Licensed under the MIT License.

⭐ Support

If you like this project, please give it a ⭐ on GitHub! It really helps support future updates.

Reporting Issues

Found a bug or have a feature request? Please open an issue with detailed information.

Demo

> tekgen new
? Choose a framework: Angular
Project generated successfully!

Code fast. Build smart. TekGen does the scaffolding so you can focus on creating.