CLI

The fireclass CLI configures a project, generates models, inspects the model directory, and verifies that the local setup is coherent.

Run the CLI

The short unscoped package delegates to @dharayush7/fireclass-cli:

$ npx fireclass init

You can also run the scoped package directly:

npx @dharayush7/fireclass-cli --help

After a local or global installation, both fireclass and fc are available as binary names.

Commands

Project discovery

Every command starts in the current working directory and walks upward to the nearest package.json. This lets commands work from a nested source directory, but it also means the nearest package controls a workspace command.

model, doctor, list, and config additionally require a readable fireclass.json at that project root.

Recommended workflow

# 1. Configure the project
npx fireclass init
 
# 2. Verify generated files and dependencies
npx fireclass doctor
 
# 3. Generate and inspect models
npx fireclass model User
npx fireclass list
 
# 4. Inspect the active configuration
npx fireclass config

Global options

npx fireclass --version
npx fireclass model --help
npx fireclass help doctor

Exit behavior

• Successful commands exit with code 0.
• Missing project/configuration, invalid non-interactive detection, install failures, existing model conflicts, and failed doctor checks exit non-zero.
• Doctor warnings do not produce a failing exit code.
• An empty model list is successful and prints the configured directory.