https://github.com/sacconazzo/directus-utils
Directus utilities CLI (automatic migrations)
https://github.com/sacconazzo/directus-utils
cli commander commands directus migrations permissions roles utilities
Last synced: 4 months ago
JSON representation
Directus utilities CLI (automatic migrations)
- Host: GitHub
- URL: https://github.com/sacconazzo/directus-utils
- Owner: sacconazzo
- License: mit
- Created: 2022-10-25T07:10:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T19:32:33.000Z (7 months ago)
- Last Synced: 2024-12-09T20:08:04.456Z (5 months ago)
- Topics: cli, commander, commands, directus, migrations, permissions, roles, utilities
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/directus-x
- Size: 71.3 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# Directus utilities CLI
Utilities scripts for Directus 11 (or latest) projects:
- Automatic migrations (reading from your db and creating a migration for deployment)
- **policies** (with permission rules)
- **roles** (with associated policy relationship attributes - policy migration needed first)
- **translations** (transations table)
- **settings**
- **files table**
- Batch updates (set common values on Directus tables)
## Prerequisites
Working in a Directus nodejs project
Ref: https://github.com/directus/directus
## Installation
```
npm install directus-x --save-dev
```
## Setup
Basically DB ref. on your local `.env` file for variables:
- `DB_CLIENT`
- `DB_HOST`
- `DB_DATABASE`
- `DB_USER`
- `DB_PASSWORD`
- `DB_PORT`
Otherwise you can create the `directus-utils.js` file in the root of your project as in the example:
```
module.exports = {
db: {
client: 'mysql',
connection: {
user: 'root',
password: 'password',
database: 'directus',
host: 'localhost',
port: 3306,
},
},
options: {
module: false, // enables ES module standard
},
}
```
## Using
Guide for list of commands:
```
npx directus-x --help
```
Example to create a migration for a **specific policy** `AAA` -> _uuid key_
npx directus-x migrate --policy AAA
Example to create a migration for the **public role** and **related permissions**
```
npx directus-x migrate --role public
```
Example to create a migration for a **specific role** `XXX` -> _uuid key_ (example: `dc7be20f-7b81-431e-8db2-3ffbbf4f9174`)
```
npx directus-x migrate -r dc7be20f-7b81-431e-8db2-3ffbbf4f9174
```
Example to create a migration for **translations strings**
```
npx directus-x migrate --translations
```
Example to update WYSIWYG options for all project fields using **batch** command
```
npx directus-x batch fields-options -k "interface = 'input-rich-text-html'" -d '{"toolbar": ["bold", "bullist", "italic", "numlist", "underline"]}'
```