Command environment

Before you start

You need a working Drupal site with Droost 2.x enabled and Drush installed. Run these commands from the site's project root. Choose DDEV if the project runs inside DDEV; choose Local Composer for the project's own vendor/bin/drush.

List the available tools

The list shows the tools available in this installation, grouped by purpose.

bash
ddev drush droost:tool

Read a tool’s help

The droost_entities tool describes entity types and fields. Read its arguments before calling it.

bash
ddev drush droost:tool droost_entities help

Inspect the entity type

Ask about node, the entity type Drupal uses for content such as articles and basic pages.

bash
ddev drush droost:tool droost_entities '{"entity_type_id":"node"}'

These commands list tools and read entity structure. They do not create content or change configuration.

Read the result

A tool call returns a JSON envelope containing success, message and data. Check whether it succeeded, then read the data returned by this site.

If the tool is missing, check that Droost is enabled and that you are running Drush from the intended project. If a call fails, read its message before trying again.

Continue with the module's tool groups or write gates.