Read a theme's entry

$ grim theme:info monitor --readme

Choosing a theme for a new project, or checking whether the one a project uses is still maintained. grim theme:info is grim module:info for themes, with one thing more to get right: frontend and admin themes are separate packages, and a name can exist as both.

Usage

$ grim theme:info monitor             # the frontend theme
$ grim theme:info float --admin       # the admin theme
$ grim theme:info monitor --readme    # the summary, then the README

It runs from anywhere; no project is needed. You must be logged in with grim auth:login.

Arguments and options

Show details for a grimoiry/grim-theme-{name} (or admin) theme

Usage

grim theme:info [--admin] [-R|--readme] [--] <name>

Arguments

Argument	Description
`name`	Theme short name (e.g. boulder24) (required)

Options

Option	Description
`--admin`	Look up an admin theme (grim-theme-admin-*) instead of frontend
`-R`, `--readme`	Print the full README in the output

What it actually does

Builds the repository name. monitor becomes grim-theme-monitor. With --admin, float becomes grim-theme-admin-float.
Asks GitHub, not the catalogue cache: the repository, its latest release and its README.
Prints a table headed with the theme and its kind: repository, URL, description, default branch, latest release, last push, archived yes or no, and the install command with the right flag, grim require --frontend monitor or grim require --admin float.
Prints the README in full after the table, with --readme.

Pitfalls

Without `--admin` an admin theme is not found

Theme not found on GitHub: grimoiry/grim-theme-float for a theme you know exists usually means it is an admin theme. Look at the repository name in the message, then add --admin. The same message is printed for a private theme your token cannot see.

The latest release is not the version you would get

The table shows the theme's newest release. grim require takes the newest one on the train your project is locked to, and skips the theme when that train has none.

After it finishes

Nothing has changed anywhere. Run the install command from the table inside a project. A required theme goes to the front of its slot in grim.json; an existing .env keeps the theme it names until you change THEME_FRONTEND or THEME_ADMIN there.

grim module:info

Read a module's entry

Show a module's description, latest release, last push and archived status straight from GitHub, with its README on request.

grim search

Search the shelves

Find modules and themes in the catalogue by a word in their name or description, before you build one again.

grim list:available

Survey the whole catalogue

List every module and theme your account can install, grouped by kind, each with the command that adds it.

grim require

Summon a module or theme

Add a module or theme to grim.json, install it with everything it depends on, and rewrite grim.lock, all inside the train the project is on.

grim make:theme

Weave a new theme

Scaffold a frontend or admin theme in the project, with its layouts and entry points, and publish it to a GitHub repository of its own.