directus-ts-typegen
v0.4.0
Published
A CLI to generate TypeScript types for your directus schema.
Downloads
69
Readme
directus-ts-typegen
A CLI that automatically generates TypeScript types for your Directus schema, making it easier to work with your Directus data in a type-safe manner.
This CLI features support for O2M (One-to-Many), M2O (Many-to-One), M2M (Many-to-Many), and M2A (Many-to-Any) relations.
Installation
Global Installation
npm install -g directus-ts-typegenAs Dev Dependency
npm install --save-dev directus-ts-typegenOne-time Usage
npx directus-ts-typegenUsage and Options
Interactive Mode
When you run the CLI without all required options, it will prompt you interactively:
npx directus-ts-typegenThe CLI will ask for:
- Directus instance URL (with connectivity validation)
- Authentication method (email/password or static token)
- Credentials based on your chosen auth method
- Output file location (optional - defaults to stdout)
- Confirmation before overwriting existing files
Command Line Options
npx directus-ts-typegen [options]--directus-host: Host address of your directus instance--directus-email: Email address of your directus admin user--directus-password: Password of your directus admin user--directus-token: Static token of your directus admin user--directus-output: Location of the file the types will be written to. If not set, types output to stdout
These options can also be set using environment variables:
DIRECTUS_TS_TYPEGEN_HOST=https://your-directus.com
DIRECTUS_TS_TYPEGEN_PASSWORD=yourpassword
[email protected]
DIRECTUS_TS_TYPEGEN_TOKEN=your-static-token
DIRECTUS_TS_TYPEGEN_OUTPUT=./types/directus.tsAuthentication
The CLI supports two authentication methods to access your Directus instance:
Email & Password
npx directus-ts-typegen --directus-host https://your-directus.com --directus-email [email protected] --directus-password yourpasswordStatic Access Token
npx directus-ts-typegen --directus-host https://your-directus.com --directus-token your-static-tokenNote: Static tokens are recommended for CI/CD environments and automated workflows.
License
Published under the MIT License.
Need help or found a bug? Please open an issue on the project repository.
