Getting Started with Kybernus

Welcome to Kybernus! This guide will help you install the CLI and generate your first production-ready backend project in minutes.

#1. Installation

Kybernus is a Node.js CLI tool. You'll need Node.js 18+ installed on your machine.

Global Installation (Recommended)

Installing globally allows you to run kybernus from any directory.

bashCopy
npm install -g kybernus

Using npx (One-time use)

If you prefer not to install it globally, you can run the latest version on demand:

bashCopy
npx kybernus init

#2. Creating Your First Project

The init command is the heart of Kybernus. It launches an interactive wizard to configure your new application.

bashCopy
kybernus init

The Wizard Flow

1. Project Name: Choose a name (kebab-case recommended, e.g., my-awesome-api).
2. Stack Selection:
   • Node.js (Express)
   • Java Spring Boot
   • Next.js
   • NestJS
   • Python FastAPI
3. Architecture:
   • MVC (Model-View-Controller)
   • Clean Architecture
   • Hexagonal Architecture
4. DevOps & Extras:
   • Docker & Docker Compose.
   • CI/CD Pipelines (GitHub Actions).
   • Terraform (AWS Infrastructure).
   • AI Documentation (Gemini).

#3. Next Steps

Once generated, navigate into your project folder. You'll find a fully configured codebase ready to run.

bashCopy
cd my-awesome-api
npm install
npm run dev

Check out the README.md inside your generated project for specific build and run instructions tailored to the stack you chose.