Roadie CLI

Published on April 4th, 2022

The Roadie Entity CLI allows you to create, update and delete entities in the Roadie catalog via the public API. This option allows you to manage entities from sources where Roadie does not have an existing Entity provider.

Get an API token

Before you start you will first need to get an API key.

Install the CLI

You can install the cli with the following command

npm install -g @roadiehq/roadie-cli

Load a catalog item

Run the command you see on the right hand side to create the catalog item.

Visit the created catalog item in Roadie

After running the command, you can find the Catalog item in the Roadie UI by visiting: https://<tenant name>, selecting the tab that represents the entity you created and then clicking the item name in the list.

Next Steps