PGS CLI - Project Generator System

🚀 Overview

The PGS CLI is a lightweight, developer-friendly command-line interface that streamlines project and management with built-in authentication. Whether you're bootstrapping a new project or managing secure workflows, PGS keeps things fast, consistent, and secure.

PGS CLI – Project Generator System: Quickly scaffold projects, fetch boilerplates, and access dev tools from your terminal.

✨ Features

• 🔐 Secure Authentication - Built-in login/logout system with token management
• 🎯 Project Templates - Create new projects from predefined templates
• 👥 User Management - Create and delete user accounts
• 🎨 Beautiful CLI - Colorful, gradient-styled interface with ASCII art
• ⚡ Fast & Lightweight - Minimal dependencies, maximum performance
• 🛠️ Developer Tools - Integrated development utilities

📦 Installation

Global Installation (Recommended)

npm install -g pgsio-cli

Local Installation

npm install pgsio-cli

From Source

git clone https://github.com/yourusername/pgsio-cli.git
cd pgsio-cli
npm install
npm link

🎯 Quick Start

After installation, you can start using PGS CLI immediately:

# Show help and available commands
pgs -h

# Login to your account
pgs login

# Create a new project
pgs create

# Show version information
pgs -v

📖 Commands

Authentication Commands

# Login to the system
pgs login
pgs login -e [email protected] -p yourpassword

# Logout from the system
pgs logout

Project Commands

# Create a new project from template
pgs create
pgs create -t template-name

User Management

# Create a new user
pgs -u create

# Delete a user
pgs -u delete

Information Commands

# Show help information
pgs -h

# Show version information
pgs -v

🔧 Configuration

PGS CLI stores its configuration in cli.json and authentication tokens in .pgscli.cred. These files are automatically managed by the CLI.

CLI Configuration (cli.json)

{
    "name": "PGS CLI",
    "fullname": "PGS Command Line Interface",
    "version": "1.0.0",
    "build": "pgsio-cli/pgsio",
    "description": "The PGS CLI is a lightweight, developer-friendly command-line interface...",
    "author": "Alan Sha Salim",
    "website": "https://cli.pgsio.com"
}

🏗️ Project Structure

pgsio-cli/
├── cli/
│   ├── commands/          # Command implementations
│   │   ├── auth.js        # Authentication commands
│   │   ├── create.js      # Project creation commands
│   │   ├── initCLI.js     # CLI initialization
│   │   └── defaultSelector.js
│   ├── api.js             # API client
│   ├── config.js          # Configuration loader
│   ├── index.js           # CLI command router
│   └── start.js           # Startup and help commands
├── cli.json               # CLI configuration
├── index.js               # Main entry point
├── package.json           # Package configuration
└── README.md              # This file

🛠️ Development

Prerequisites

• Node.js 16.0.0 or higher
• npm or yarn package manager

Setup Development Environment

# Clone the repository
git clone https://github.com/yourusername/pgsio-cli.git
cd pgsio-cli

# Install dependencies
npm install

# Link for local development
npm link

# Test the CLI
pgs -h

Dependencies

• Commander.js - Command-line framework
• Inquirer.js - Interactive prompts
• Chalk - Terminal styling
• Figlet - ASCII art text
• Gradient String - Gradient colors
• Ora - Loading spinners
• Axios - HTTP client
• Validator - String validation

Building

# Run tests (when available)
npm test

# Package the application
npm pack

🌐 API Integration

PGS CLI integrates with the PGS API for authentication and project management. The API client is configured in cli/api.js and automatically handles:

• Authentication token management
• Request/response handling
• Error handling and retries

🤝 Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Commit your changes: git commit -m 'Add amazing feature'
4. Push to the branch: git push origin feature/amazing-feature
5. Open a Pull Request

Development Guidelines

• Follow existing code style and conventions
• Add tests for new features
• Update documentation as needed
• Ensure all tests pass before submitting

📄 License

This project is licensed under the ISC License. See the LICENSE file for details.

👨‍💻 Author

Alan Sha Salim

• Website: https://cli.pgsio.com
• GitHub: @yourusername

🆘 Support

If you encounter any issues or need help:

1. Check the documentation
2. Search existing issues
3. Create a new issue

🔄 Changelog

Version 1.0.0

• Initial release
• Authentication system (login/logout)
• Project template creation
• User management features
• CLI interface with help commands