Kix CLI

Kix is a CLI tool for shipping Javascript/Typescript projects.

Think of the architecture as a pipeline, a chain of functions performing duties and passing info to the next function until the intended task is completed.

Installation

npm install -g kix-cli

Commands

kix create <projectName>

Scaffolds a new full-stack project interactively.

kix create my-app

You will be prompted to choose:

• Stack — MERN, PERN, or Express
• Language — JavaScript or TypeScript
• Package Manager — npm, yarn, or bun
• Frontend — Next.js or Vue
• Database — MongoDB or PostgreSQL (Express only — MERN defaults to MongoDB, PERN defaults to PostgreSQL)
• GitHub Repo — optional, press Enter to skip

kix push <repoUrl>

Initializes git, commits all files, and pushes to the provided GitHub repo URL.

kix push https://github.com/your-username/your-repo.git

kix delete-env

Removes .env files from your entire Git history using git filter-repo.

kix delete-env

Requires git-filter-repo to be installed. You will need to force push after running this.

Generated Project Structure

MERN / PERN

my-app/
├── frontend/        # Next.js or Vue (Vite)
└── backend/         # Express

Express (standalone)

my-app/
└── backend/

Backend structure

backend/
├── config/
│   └── db.js / db.ts        # Database connection (MongoDB or PostgreSQL)
├── src/
│   ├── controllers/
│   ├── middleware/
│   ├── routes/
│   ├── services/
│   ├── utils/
│   └── server.js / server.ts
├── server.js / server.ts     # Entry point
├── .env
├── .gitignore
└── package.json

Frontend — Next.js

frontend/
├── src/
│   └── app/
│       └── page.tsx / page.jsx    # Fetches "/" from backend
├── .env.local                      # NEXT_PUBLIC_API_URL=http://localhost:3000
└── ...

Frontend — Vue (Vite)

frontend/
├── src/
│   └── App.vue / App.tsx           # Fetches "/" from backend
├── .env                            # VITE_API_URL=http://localhost:3000
└── ...

Environment Variables

Backend .env

MongoDB:

PORT=3000
MONGO_URI=<your-mongo-uri-here>

PostgreSQL:

PORT=3000
DATABASE_URL=<your-postgres-url-here>

Frontend .env.local (Next.js)

NEXT_PUBLIC_API_URL=http://localhost:3000

Frontend .env (Vue)

VITE_API_URL=http://localhost:3000

Running the Project

cd my-app/backend
npm run dev

cd my-app/frontend
npm run dev

License

ISC