Directus: Automate Directus with the CLI

Start Directus, retrieve its credentials, and change its configuration programmatically with the Stackhero CLI

👋 歡迎來到 Stackhero 文件！

Stackhero 提供 Directus cloud 服務，只需 2 分鐘即可投入生產使用：

無限的集合、項目、用戶、角色、API 請求和傳輸

使用 HTTPS 保護的可自定義域名（例如，https://cms.your-company.com）

包含專用且無限的電子郵件伺服器

包含 Redis 緩存伺服器以提供高性能

由專用私有 VM提供的最佳性能和強大安全性。

一鍵更新，輕鬆維護

節省時間並簡化您的生活：只需 5 分鐘即可嘗試 Stackhero 的 Directus cloud solution！

This guide shows how to create a Directus service, read its credentials, and update its configuration entirely from the command line, with no clicks in the dashboard. It is ideal for scripts, CI pipelines, and AI agents.

It uses the Stackhero CLI. Install it first:

curl -fsSL https://www.stackhero.io/install.sh | sh

1. Authenticate

The simplest way is to log in from your browser. The CLI opens a page where you approve the access (no password or 2FA code is ever handled by the CLI):

stackhero login

Your credentials are then saved locally and reused by every following command.

For scripts, CI pipelines, and AI agents, use a non-interactive access token instead. Create one from your dashboard (Account > Access tokens) and export it. The CLI (and any script) picks it up automatically:

export STACKHERO_TOKEN="usr-xxxxxx:your-token"

2. Find the Directus service store

List your organizations to get your organization id, then find the Directus store:

# Your organization id (org-xxxxxx)
stackhero organizations-list

# The Directus service stores available to that organization
stackhero services-store-list --organization-id=org-xxxxxx --name="directus"

Pick the svs-xxxxxx id of the version you want.

3. Pick an instance size and a region

# Instance sizes (ist-xxxxxx) available for that service store
stackhero instances-store-list --organization-id=org-xxxxxx --service-store-id=svs-xxxxxx

# Available regions
stackhero regions-list

4. Create the service

The script below creates a stack, adds Directus to it, waits until it is running, reads its configuration (which contains the generated credentials), and applies a new configuration.

#!/bin/bash
set -e

export STACKHERO_TOKEN="usr-xxxxxx:your-token"

organizationId="org-xxxxxx"
serviceStoreId="svs-xxxxxx"   # a Directus service store (step 2)
instanceStoreId="ist-xxxxxx"  # an instance size (step 3)
regionId="europe"             # a region id (step 3)

# Create a stack to host the service
stackId=$(stackhero --format=script stack-create \
  --organization-id="${organizationId}" \
  --name="My Directus stack")
echo "Stack created: ${stackId}"

# Add Directus to the stack
serviceId=$(stackhero --format=script service-add \
  --stack-id="${stackId}" \
  --service-store-id="${serviceStoreId}" \
  --instance-store-id="${instanceStoreId}" \
  --region-id="${regionId}")
echo "Service added: directus"

# Wait until the service is running (a couple of minutes)
stackhero service-wait-for --service-id="directus"

# Retrieve the service configuration, including its generated credentials
stackhero service-configuration-get --service-id="directus" --format=json

5. Retrieve credentials

service-configuration-get returns the full configuration of the service, including the generated passwords and connection details. As JSON (handy for scripts and agents):

stackhero service-configuration-get --service-id=svc-xxxxxx --format=json

6. Change the configuration

Get an example of the expected configuration, then apply your own:

# See the configuration schema and an example for this service
stackhero service-configuration-example --service-id=svc-xxxxxx

# Apply a new configuration (the service restarts to apply it)
stackhero service-configuration-set \
  --service-id=svc-xxxxxx \
  --configuration='{ "...": "..." }'

# Wait until the new configuration is applied
stackhero service-wait-for --service-id=svc-xxxxxx

That is the full lifecycle: start, read credentials, reconfigure, all scriptable. See the full CLI documentation for every command and the non-interactive STACKHERO_TOKEN authentication used here.