genesix-cli

A powerful CLI tool to scaffold modern web applications starting with Express.js — JavaScript and TypeScript supported.

Table of Contents

• About
• Features
• Installation
• Usage
• Command Syntax
• Templates
• Project Structure
• Development
• Contributing
• License

About

genesix-cli is a developer-friendly CLI tool designed to help you quickly generate server-side applications. It currently supports Express.js projects and will be extended in the future to include more stacks like React.

Features

• Scaffold an Express.js app in JavaScript or TypeScript.
• Automatically sets up project structure, base files, and configurations.
• Supports inline configuration with project name, template type, port number, and database.
• Interactive prompts available if you omit any options.
• Installs up-to-date dependency versions.
• Lightweight and zero-config — just run and code.
• Built for expansion (e.g., React scaffolding planned).

Installation

Install globally to access the CLI anywhere:

npm install -g genesix-cli

Or run directly without installing:

npx genesix-cli create-express-app my-app temp:js port:300 db:mongodb

Usage

gx create-express-app my-app temp:js port:300 db:mongodb

• my-app → The project/folder name (required).
• temp: → Defines the template (js or ts).
• port: → Defines the server port (default: 3000).
• db: → Defines the database to set up (e.g., mongodb, mysql, or none).

If you leave out any option, the CLI will prompt you interactively.

Command Syntax

gx create-express-app project-name temp:<js|ts> port:<number> db:<database>

Arguments:

• project-name → Required. Name of the project/folder to be created.
• temp: → Required. Choose js for JavaScript or ts for TypeScript.
• port: → Optional. Port for the Express app (default: 3000).
• db: → Optional. Database to integrate (mongodb, mysql, or none).

Templates

| Template | Description | | -------- | --------------------------------- | | js | Basic Express app in JavaScript | | ts | Express app with TypeScript setup |

Project Structure

The generated folder will look like:

my-app/
├── public/
│   └── index.html
├── src/
│   ├── controllers/
│   │   └── mainController.js (or .ts)
│   ├── middleware/
│   │   └── index.js (or .ts)
│   ├── routes/
│   │   └── mainRoutes.js (or .ts)
│   └── server.js (or index.ts)
├── .env
├── .gitignore
├── package.json
├── README.md
└── ...

Development

Clone and run the CLI locally:

git clone https://github.com/thesixers/gx.git
cd gx
npm install

# Run CLI locally
node bin/index.js

Contributing

Contributions are welcome!

• Open issues
• Submit pull requests
• Share feature suggestions

License

ISC License

Note: More commands like create-react-app are coming soon. Stay tuned!

Do you want me to also add examples for multiple databases (like mysql, postgres along with mongodb) in the README so it’s future-proof?