TRB CLI

TRB-CLI is a handy Node.js CLI that automates the process of managing blocks in a theme-redone theme. Instead of manually creating new blocks, and copying and renaming files, you can do just that with a single simple command.

To learn how to manually create a new block, read the Single Block Creation Process page.


Installation

  • Install the trb-cli package globally via the npm install trb-cli -g command.
  • Verify that the package was installed successfully by running the trb command; This command lists all the available trb-cli commands. If that’s the case, you are all set up.

Usage and Commands

To be able to use the TRB CLI you should be inside the root of the theme-redone theme from inside the terminal.

Commands will only run if the CLI detects that it’s called from the theme root which it verifies by the presence of the "name": "theme-redone" line inside the theme’s package.json, and a few other checks.


Main Commands

  • trb add <kebab-case-block-name>
    Creates a new block with the desired name (must be in kebab-case)
  • trb remove <kebab-case-block-name>
    Removes the existing block
  • trb rename <kebab-case-block-name-original> <kebab-case-block-name-renamed>
    Renames selected block
  • trb copy <kebab-case-block-name-copy-from> <kebab-case-block-name-copy-to>
    Copies selected block into a new block with the desired name

There are a few more commands that you can find out about by running either only the trb command or the trb help one.

Join Our Newsletter

To get updates about Theme Redone