Skip to content
GRIMOIRY

Read a module's entry

$ grim module:info cart-orders --readme

You found a name in grim search and sixty characters of description were not enough. grim module:info shows the rest: whether the module is alive, when it last moved, and with --readme what its authors wrote about it. For a theme the command is grim theme:info.

Usage

$ grim module:info cart-orders             # the summary
$ grim module:info cart-orders --readme    # the summary, then the README

It runs from anywhere; no project is needed. You must be logged in with grim auth:login. The name is the short one: cart-orders, not grim-cart-orders.

Arguments and options

Show details (description, latest release, README) for a grimoiry/grim-{name} module

Usage

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

Arguments

Argument Description
name Module short name (e.g. bank, cart-orders) (required)

Options

Option Description
-R, --readme Print the full README in the output

What it actually does

  1. Asks GitHub, not the catalogue cache, so the answer is current. It reads the repository, its latest release and its README.
  2. Prints a table: repository, URL, description, default branch, latest release, last push, archived yes or no, and the install command.
  3. Prints the README in full after the table, with --readme. Without it, one line reminds you the flag exists.

Pitfalls

The latest release is not the version you would get

The table shows the newest release of the module. grim require installs the newest one on the train your project is locked to, which can be older. A module whose latest release is on a train ahead of yours is a reason to look at grim update, not an error.

Not found can mean not allowed

Module not found on GitHub: grimoiry/grim-cart-orders is printed both for a name that does not exist and for a private repository your token cannot see. GitHub answers the two cases the same way. Check the spelling with grim search, then ask for access.

After it finishes

Nothing has changed anywhere. The last row of the table is the command to run next, from inside a project.

$ grim require cart-orders

grim theme:info

Read a theme's entry

Show a frontend or admin theme'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 auth:login

Log grim in to GitHub

Give grim a GitHub token, from your gh login or a personal access token, and hand the same token to Composer and Docker.