mboxberlin/directus-cli

DirectusCLI

Abstract

A tool to help you deal with https://github.com/directus/directus data models and user data. The CLI uses the Directus REST API to export and restore:

• Directus Collections, including all related Directus meta settings (like interface and translations) and relations (the model)
• Directus Settings
• Items
• Files

Motivation

We deal with a lot of Directus instances in development and have the need to share our data models quickly and reliably between multiple (container) instances. Since Directus currently does not provide such a functionality, this CLI was made just for that.

Limitations

Currently the import only works on an e***y database. Since you are not able to change certain fields after a collection was created this functionality will likely never exist.

Installation as container in your git repository

This application is intended to be run from a container. It should be part of your compose stack.

Quick Start

1. Add directus-container as a submodule: git submodule add git@repos.m-box.de:cms/directus-container.git && git submodule update --recursive
2. Setup your .env file in directus-container/
3. Create the data directory, ./directus-data. Files created by the cli will go here by default. You might want to check this into your git repo.
4. Start the stack using docker-compose -f compose.yaml -f directus-cli.yaml up -d. Note: This will automatically import anything in ./directus-data
5. Use the cli by running docker-compose -f compose.yaml -f directus-cli.yaml run cli export-model

compose file

yaml
# compose.yaml
services:
  db:
   # ...
  directus:
   # ...
  directus-cli:
    image: mboxberlin/directus-cli:${CLI_VERSION:-latest}
    environment:
      DIRECTUS_API_ENDPOINT: ${DIRECTUS_CLI_ENDPOINT:-http://directus:8055}
      ADMIN_EMAIL: ${ADMIN_EMAIL:-email@example.com}
      ADMIN_PASSWORD: ${ADMIN_PASSWORD:-directus}
      DIRECTUS_CLI_BASEDIR: /directus-data
      DIRECTUS_CLI_INIT_ACTIONS: ${DIRECTUS_CLI_INIT_ACTIONS:-import-model import-settings}
    volumes:
      - ${DIRECTUS_CLI_BASEDIR:-../directus-data}:/directus.data:Z

Installation from source

1. Install ruby https://www.ruby-lang.org/
2. Clone this repository
3. gem install bundler
4. bundle install
5. Optional, add the repo to your PATH: export PATH=$(pwd):$PATH

Importing / exporting our db model

Quick start

shell
# export
$ directus-cli --user email@example.com --password=directus --uri=https://directus.example.com export-model --path=model-file.yaml
Exported 6 collections and 11 relations to './model-file.yaml'

# import
$ directus-cli --user email@example.com --password=directus --uri=https://directus.example.com import-model --path=model-file.yaml
Imported 6 collections and 11 relations

For general help use directus-cli --help and use directus-cli <verb> --help for full documentation. General flags like user name, password ect. can be set via environment variables. See See environment section for more.

Automation

1. Run the stack and create your model
2. Export your model: docker-compose run directus-cli export-model
3. The next time an e***y Directus instance (without any collections) is started your model will be imported automatically

Environment