Documentation
List model files, class names, and Firestore collections from the configured models directory.
list inspects the configured models directory and prints the model metadata
it can recognize. ls is an equivalent alias.
fireclass list
fireclass lsThe command has no command-specific options.
The command:
models.dir from fireclass.json..ts.index.ts.BaseModel.@Collection("...") decorator.Discovery is intentionally lightweight and does not execute or compile model files.
Top-level scan only
Nested directories are not traversed. Re-export barrels, computed collection names, decorator aliases, and unusual class formatting may not be recognized.
Given:
@Collection("users")
export class User extends BaseModel<User> {}The list includes:
User → "users" (user.ts)When the class pattern is not recognized, the filename is used. When the
collection pattern is not recognized, the collection is displayed as ?.
An absent or empty models directory is not an error. The command reports the configured directory and suggests:
fireclass model <Name>The command exits non-zero only when it cannot find a project root or readable
fireclass.json. Unrecognized model metadata and an empty directory are
successful results.
Use model to generate files that follow the recognized patterns.