Blackout CLI

A simple CLI tool to quickly set up and manage boilerplate code for Trinex Blackout Next.js projects.

Usage

You don't need to install this tool. You can run it directly using npx:

npx blackout-cli <command>

Commands

1. init

Sets up your project by adding essential configuration files (authentication components, user context, and proxy middleware) into your src/ folder.

npx blackout-cli init

Note: If a file already exists, the tool will ask if you want to overwrite it.

2. gen-api

Generates a typed API client from your backend documentation. It automatically configures the client to handle authentication (cookies) and environment variables.

npx blackout-cli gen-api [backend-url]

• Default URL: http://localhost:8080/api
• What it does: Creates src/api/client.ts and ensures you have the necessary dependencies (zod, @zodios/core) installed.

3. clean

Removes all files and folders generated by the init command, leaving your src/ directory clean.

npx blackout-cli clean

4. help

Shows the list of available commands.

npx blackout-cli help

Requirements

• Node.js
• A NextJS 16 project with a src/ directory.