The fireclass package is a thin launcher for @dharayush7/fireclass-cli. It exists so project setup uses the short command:

npx fireclass init

All command behavior, generated files, diagnostics, and framework support come from the scoped CLI package. This launcher does not contain an SDK or a second CLI implementation.

Requirements

• Node.js 18 or newer.
• Next.js, React, or Express project containing package.json.
• Framework-specific Firebase setup completed before initialization.

Prepare Firebase first:

• Next.js setup
• React setup
• Express setup

Commands

| Command | Purpose | | --- | --- | | npx fireclass init | Detect the framework and configure Fireclass | | npx fireclass model <Name> | Generate a typed model | | npx fireclass doctor | Validate local dependencies, files, exports, and decorators | | npx fireclass list | List discoverable models and collections | | npx fireclass ls | Alias for list | | npx fireclass config | Print the resolved fireclass.json | | npx fireclass --help | Print command help | | npx fireclass --version | Print the scoped CLI version |

The local binary aliases are fireclass and fc.

Initialize a project

npx fireclass init

The initializer:

1. Finds the nearest project root.
2. Detects Next.js, React, or Express.
3. Detects npm, pnpm, Yarn, or Bun.
4. Installs the matching Fireclass runtime and required peers.
5. Writes fireclass.json with the public schema URL.
6. Creates the app-bound Fireclass entry.
7. References or creates the framework Firebase entry when applicable.
8. Enables TypeScript decorator options.
9. Creates a starter model.

Useful automation options:

npx fireclass init --yes --framework next --pm pnpm
npx fireclass init --yes --framework react --pm npm
npx fireclass init --yes --framework express --pm npm --skip-install

Existing Firebase files are referenced and never overwritten.

Generate models

npx fireclass model User
npx fireclass model user-profile --collection user_profiles
npx fireclass model Order --dir src/entities

Generated models import Collection from the selected SDK and BaseModel from the app's initialized Fireclass entry.

Verify and inspect

npx fireclass doctor
npx fireclass list
npx fireclass config

Doctor is read-only and exits with code 1 when a required check fails. It does not connect to Firebase or test Firestore Security Rules.

fireclass.json

Generated configuration begins with:

{
  "$schema": "https://fireclass.ayushdhar.com/schema.json"
}

The file contains framework, package-manager, SDK, Firebase export, Fireclass entry, and models-directory metadata. It must never contain Firebase secrets.

Scoped package equivalence

These execute the same CLI:

npx fireclass doctor
npx @dharayush7/fireclass-cli doctor

Install @dharayush7/fireclass-cli directly only when your project prefers a scoped development dependency. Use fireclass for the shortest npx workflow.

Documentation

• Complete CLI overview
• init reference
• model reference
• doctor reference
• list reference
• config reference
• fireclass.json reference

See CHANGELOG.md for version history and RELEASE_NOTES.md for the current release summary.

License

MIT. Copyright Ayush Dhar.