directus-template-cli 0.5.0-beta.11 → 0.5.0-beta.12

package/README.md

@@ -4,21 +4,20 @@ A CLI tool to make applying or extracting Directus "templates" a little easier..
 
 **Notes:**
 
-- This is a pre-release. It is recommended for use on POC, demo, or greenfield projects only.
-- ⚠️ Known issues with using MySQL currently, please use ONLY PostgreSQL or SQLite for your database provider.
-- Templates are applied / extracted on an all or nothing basis – meaning that all the schema, content, and system settings are extracted or applied. We'd love to support more granular operations in the future. (PRs welcome 🙏)
-- If you are extracting or applying from a remote source, the script can take quite a while depending on the "size" of your instance (how many collections, how many items in each collection, number and size of assets, etc). The script applies a strict rate limit of 10 requests per second using bottleneck.
+- This is a beta release. It is recommended for use on POC, demo, or greenfield projects only. When applying templates, you should always backup your project/database before applying a template.
 
-## Breaking Changes in v0.4.0
+- ⚠️ Known issues with using MySQL currently. We highly recommend using PostgreSQL or SQLite for your database provider. If you're using PostgreSQL in production, we recommend using PostgreSQL in local development as well.
+- If you are extracting or applying from a remote source, the script can take quite a while depending on the "size" of your instance (how many collections, how many items in each collection, number and size of assets, etc). The script applies a strict rate limit of 10 requests per second using bottleneck.
 
-- Templates are no longer being bundled with the CLI or included in this repository. Templates are stored in this repository - https://github.com/directus-community/directus-templates.
-- When applying templates, the schema snapshot / schema diff is no longer used to create collections, fields, and relations. This allows support for loading multiple templates into a single instance.
+Breaking Changes in v0.5.0
 
-## Usage
+- The CLI is now compatible with Directus 11. If you need to apply or extract to an instance of Directus 10, you can use v0.4.0 of the CLI. `npx directus-template-cli@0.4 extract` or `npx directus-template-cli@0.4 apply`.
 
 Using the @latest tag ensures you're receiving the latest version of the packaged templates with the CLI. You can review [the specific versions on NPM](https://www.npmjs.com/package/directus-template-cli) and use @{version} syntax to apply the templates included with that version.
 
-### Applying a Template
+## Applying a Template
+
+🚧 Make backups of your project/database before applying templates.
 
 1. Create a Directus instance on [Directus Cloud](https://directus.cloud) or using self-hosted version.
 2. Login and create a Static Access Token for the admin user.
@@ -29,20 +28,148 @@ Using the @latest tag ensures you're receiving the latest version of the package
 $ npx directus-template-cli@latest apply
 ```
 
-You can choose from our templates bundled with the CLI or you can also choose a template from a local directory.
+You can choose from our community maintained templates or you can also choose a template from a local directory or a public GitHub repository.
+
+
+### Programmatic Mode
+
+For CI/CD pipelines or automated scripts, you can use the programmatic mode:
+
+
+Using a token:
+
+```
+$ npx directus-template-cli@latest apply -p --directusUrl="http://localhost:8055" --directusToken="admin-token-here" --templateLocation="./my-template" --templateType="local"
+```
+
+Using email/password:
+
+```
+npx directus-template-cli@latest apply -p --directusUrl="http://localhost:8055" --userEmail="admin@example.com" --userPassword="admin" --templateLocation="./my-template" --templateType="local"
+```
+
+Partial apply (apply only some of the parts of a template to the instance):
+
+```
+npx directus-template-cli@latest apply -p --directusUrl="http://localhost:8055" --userEmail="admin@example.com" --userPassword="your-password" --templateLocation="./my-template" --templateType="local" --partial --schema --permissions --no-content
+
+```
+
+Available flags for programmatic mode:
+
+- `--directusUrl`: URL of the Directus instance to apply the template to (required)
+- `--directusToken`: Token to use for the Directus instance (required if not using email/password)
+- `--userEmail`: Email for Directus authentication (required if not using token)
+- `--userPassword`: Password for Directus authentication (required if not using token)
+- `--templateLocation`: Location of the template to apply (required)
+- `--templateType`: Type of template to apply. Options: community, local, github (required)
+- `--partial`: Enable partial template application
+- `--content`: Load Content (data)
+- `--dashboards`: Load Dashboards
+- `--extensions`: Load Extensions
+- `--files`: Load Files
+- `--flows`: Load Flows
+- `--permissions`: Load Permissions
+- `--schema`: Load Schema
+- `--settings`: Load Settings
+- `--users`: Load Users
+
+When using `--partial`, you can also use `--no` flags to exclude specific components from being applied. For example:
+
+```
+$ npx directus-template-cli@latest apply -p --directusUrl="http://localhost:8055" --userEmail="admin@example.com" --userPassword="your-password" --templateLocation="./my-template" --templateType="local" --partial --no-content --no-users
+```
+
+This command will apply the template but exclude content and users. Available `--no` flags include:
+
+- `--no-content`: Skip loading Content (data)
+- `--no-dashboards`: Skip loading Dashboards
+- `--no-extensions`: Skip loading Extensions
+- `--no-files`: Skip loading Files
+- `--no-flows`: Skip loading Flows
+- `--no-permissions`: Skip loading PermissionsI
+- `--no-schema`: Skip loading Schema
+- `--no-settings`: Skip loading Settings
+- `--no-users`: Skip loading Users
+
+
+#### Template Component Dependencies
 
-### Extracting a Template
+When applying templates, certain components have dependencies on others. Here are the key relationships to be aware of:
+
+- `--users`: Depends on `--permissions`. If you include users, permissions will automatically be included.
+- `--permissions`: Depends on `--schema`. If you include permissions, the schema will automatically be included.
+- `--content`: Depends on `--schema`. If you include content, the schema will automatically be included.
+- `--files`: No direct dependencies, but often related to content. Consider including `--content` if you're including files.
+- `--flows`: No direct dependencies, but may interact with other components. Consider your specific use case.
+- `--dashboards`: No direct dependencies, but often rely on data from other components.
+- `--extensions`: No direct dependencies, but may interact with other components.
+- `--settings`: No direct dependencies, but affects the overall system configuration.
+
+When using the `--partial` flag, keep these dependencies in mind. For example:
+
+```
+$ npx directus-template-cli@latest apply -p --directusUrl="http://localhost:8055" --directusToken="admin-token-here" --templateLocation="./my-template" --templateType="local" --partial --users
+```
+
+This command will automatically include `--permissions` and `--schema` along with `--users`, even if not explicitly specified.
+
+If you use `--no-` flags, be cautious about excluding dependencies. For instance, using `--no-schema` while including `--content` may lead to errors or incomplete application of the template.
+
+## Extracting a Template
 
 The CLI can also extract a template from a Directus instance so that it can be applied to other instances.
 
+Note: We do not currently support partial extraction. The entire template will be extracted. We thought it better to have the data and not need it, than need it and not have it.
+
 1. Make sure you remove any sensitive data from the Directus instance you don't want to include in the template.
 2. Login and create a Static Access Token for the admin user.
 3. Copy the static token and your Directus URL.
 4. Run the following command on the terminal and follow the prompts.
 
 ```
-$ npx directus-template-cli@latest extract
+npx directus-template-cli@latest extract
+```
+
+### Programmatic Mode
+
+For CI/CD pipelines or automated scripts, you can use the programmatic mode:
+
+Using a token:
+
 ```
+npx directus-template-cli@latest extract -p --templateName="My Template" --templateLocation="./my-template" --directusToken="admin-token-here" --directusUrl="http://localhost:8055"
+```
+
+Using email/password:
+
+```
+npx directus-template-cli@latest extract -p --templateName="My Template" --templateLocation="./my-template" --userEmail="admin@example.com" --userPassword="admin" --directusUrl="http://localhost:8055"
+```
+
+Available flags for programmatic mode:
+
+- `--directusUrl`: URL of the Directus instance to extract the template from (required)
+- `--directusToken`: Token to use for the Directus instance (required if not using email/password)
+- `--userEmail`: Email for Directus authentication (required if not using token)
+- `--userPassword`: Password for Directus authentication (required if not using token)
+- `--templateLocation`: Directory to extract the template to (required)
+- `--templateName`: Name of the template (required)
+
+## Logs
+
+The Directus Template CLI logs information to a file in the `.directus-template-cli/logs` directory.
+
+### Log Generation
+
+Logs are automatically generated for each run of the CLI. Here's how the logging system works:
+   - A new log file is created for each CLI run.
+   - Log files are stored in the `.directus-template-cli/logs` directory within your current working directory.
+   - Each log file is named `run-[timestamp].log`, where `[timestamp]` is the ISO timestamp of when the CLI was initiated.
+
+The logger automatically sanitizes sensitive information such as passwords, tokens, and keys before writing to the log file. But it may not catch everything. Just be aware of this and make sure to remove the log files when they are no longer needed.
+
+Note: If you encounter any issues with the CLI, providing these log files can greatly assist in diagnosing and resolving the problem.
 
 ## License
 

package/dist/commands/apply.d.ts

@@ -17,13 +17,21 @@ export default class ApplyCommand extends Command {
         settings: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         templateLocation: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         templateType: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        userEmail: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        userPassword: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         users: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
+    private checkAtLeastOneFlagEnabled;
+    private handleDependencies;
+    private handlePartialFlags;
     private initializeDirectusApi;
     private redirectToDirectusPlus;
     private runInteractive;
     private runProgrammatic;
     private selectLocalTemplate;
+    private setAllFlagsTrue;
+    private setSpecificFlags;
     private validateFlags;
+    private validateProgrammaticFlags;
 }

package/dist/commands/apply.js

@@ -19,15 +19,56 @@ class ApplyCommand extends core_1.Command {
         const typedFlags = flags;
         await (typedFlags.programmatic ? this.runProgrammatic(typedFlags) : this.runInteractive(typedFlags));
     }
+    checkAtLeastOneFlagEnabled(validatedFlags, loadFlags) {
+        const enabledFlags = loadFlags.filter(flag => validatedFlags[flag] === true);
+        if (enabledFlags.length === 0) {
+            core_1.ux.error('When using --partial, at least one component must be loaded.');
+        }
+    }
+    handleDependencies(validatedFlags, flags) {
+        if (validatedFlags.content) {
+            validatedFlags.schema = true;
+            validatedFlags.files = true;
+            if (!flags.schema || !flags.files) {
+                core_1.ux.warn('Content loading requires schema and files. Enabling schema and files flags.');
+            }
+        }
+        if (validatedFlags.users) {
+            validatedFlags.permissions = true;
+            if (!flags.permissions) {
+                core_1.ux.warn('User loading requires permissions. Enabling permissions flag.');
+            }
+        }
+    }
+    handlePartialFlags(validatedFlags, flags, loadFlags) {
+        const explicitlyEnabledFlags = loadFlags.filter(flag => flags[flag] === true);
+        const explicitlyDisabledFlags = loadFlags.filter(flag => flags[flag] === false);
+        if (explicitlyEnabledFlags.length > 0) {
+            this.setSpecificFlags(validatedFlags, loadFlags, explicitlyEnabledFlags, true);
+        }
+        else if (explicitlyDisabledFlags.length > 0) {
+            this.setSpecificFlags(validatedFlags, loadFlags, explicitlyDisabledFlags, false);
+        }
+        else {
+            this.setAllFlagsTrue(validatedFlags, loadFlags);
+        }
+        this.handleDependencies(validatedFlags, flags);
+        this.checkAtLeastOneFlagEnabled(validatedFlags, loadFlags);
+    }
     async initializeDirectusApi(flags) {
         sdk_2.api.initialize(flags.directusUrl);
         try {
-            sdk_2.api.setAuthToken(flags.directusToken);
+            if (flags.directusToken) {
+                await sdk_2.api.loginWithToken(flags.directusToken);
+            }
+            else if (flags.userEmail && flags.userPassword) {
+                await sdk_2.api.login(flags.userEmail, flags.userPassword);
+            }
             const response = await sdk_2.api.client.request((0, sdk_1.readMe)());
             core_1.ux.log(`-- Logged in as ${response.first_name} ${response.last_name}`);
         }
         catch {
-            (0, catch_error_1.default)('-- Invalid Directus token. Please check your credentials.', {
+            (0, catch_error_1.default)('-- Unable to authenticate with the provided credentials. Please check your credentials.', {
                 fatal: true,
             });
         }
@@ -39,7 +80,7 @@ class ApplyCommand extends core_1.Command {
     }
     async runInteractive(flags) {
         const validatedFlags = this.validateFlags(flags);
-        core_1.ux.styledHeader(core_1.ux.colorize(constants_1.DIRECTUS_PURPLE, 'Welcome to the Directus Template CLI'));
+        core_1.ux.styledHeader(core_1.ux.colorize(constants_1.DIRECTUS_PURPLE, 'Directus Template CLI - Apply'));
         const templateType = await inquirer.prompt([
             {
                 choices: [
@@ -84,11 +125,33 @@ class ApplyCommand extends core_1.Command {
         }
         core_1.ux.log(`You selected ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, template.templateName)}`);
         core_1.ux.log(constants_1.SEPARATOR);
-        // Get Directus URL and token
+        // Get Directus URL
         const directusUrl = await (0, auth_1.getDirectusUrl)();
-        const directusToken = await (0, auth_1.getDirectusToken)(directusUrl);
-        flags.directusUrl = directusUrl;
-        flags.directusToken = directusToken;
+        validatedFlags.directusUrl = directusUrl;
+        // Prompt for login method
+        const loginMethod = await inquirer.prompt([
+            {
+                choices: [
+                    { name: 'Directus Access Token', value: 'token' },
+                    { name: 'Email and Password', value: 'email' },
+                ],
+                default: 'token',
+                message: 'How do you want to log in?',
+                name: 'loginMethod',
+                type: 'list',
+            },
+        ]);
+        if (loginMethod.loginMethod === 'token') {
+            const directusToken = await (0, auth_1.getDirectusToken)(directusUrl);
+            validatedFlags.directusToken = directusToken;
+        }
+        else {
+            const userEmail = await core_1.ux.prompt('What is your email?');
+            validatedFlags.userEmail = userEmail;
+            const userPassword = await core_1.ux.prompt('What is your password?');
+            validatedFlags.userPassword = userPassword;
+        }
+        await this.initializeDirectusApi(validatedFlags);
         if (template) {
             core_1.ux.styledHeader(core_1.ux.colorize(constants_1.DIRECTUS_PURPLE, `Applying template - ${template.templateName} to ${directusUrl}`));
             await (0, index_js_1.default)(template.directoryPath, validatedFlags);
@@ -156,15 +219,19 @@ class ApplyCommand extends core_1.Command {
             }
         }
     }
-    validateFlags(flags) {
-        if (flags.programmatic) {
-            if (!flags.directusUrl || !flags.directusToken) {
-                core_1.ux.error('Directus URL and token are required for programmatic mode.');
-            }
-            if (!flags.templateLocation) {
-                core_1.ux.error('Template location is required for programmatic mode.');
-            }
+    setAllFlagsTrue(flags, loadFlags) {
+        for (const flag of loadFlags) {
+            flags[flag] = true;
         }
+        return flags;
+    }
+    setSpecificFlags(flags, allFlags, specificFlags, value) {
+        for (const flag of allFlags) {
+            flags[flag] = specificFlags.includes(flag) === value;
+        }
+    }
+    validateFlags(flags) {
+        this.validateProgrammaticFlags(flags);
         const loadFlags = [
             'content',
             'dashboards',
@@ -177,34 +244,30 @@ class ApplyCommand extends core_1.Command {
             'users',
         ];
         const validatedFlags = { ...flags };
+        if (flags.programmatic && !flags.partial) {
+            return this.setAllFlagsTrue(validatedFlags, loadFlags);
+        }
         if (flags.partial) {
-            const enabledFlags = loadFlags.filter(flag => flags[flag] === true);
-            if (enabledFlags.length === 0) {
-                core_1.ux.error('When using --partial, at least one component flag must be set to true.');
-            }
-            // Handle dependencies
-            if (flags.content) {
-                validatedFlags.schema = true;
-                validatedFlags.files = true;
-                if (!flags.schema || !flags.files) {
-                    core_1.ux.warn('Content loading requires schema and files. Enabling schema and files flags.');
-                }
-            }
-            if (flags.users) {
-                validatedFlags.permissions = true;
-                if (!flags.permissions) {
-                    core_1.ux.warn('User loading requires permissions. Enabling permissions flag.');
-                }
-            }
+            this.handlePartialFlags(validatedFlags, flags, loadFlags);
         }
         else {
-            // If not partial, set all flags to true
-            for (const flag of loadFlags) {
-                validatedFlags[flag] = true;
-            }
+            this.setAllFlagsTrue(validatedFlags, loadFlags);
         }
         return validatedFlags;
     }
+    validateProgrammaticFlags(flags) {
+        if (!flags.programmatic)
+            return;
+        if (!flags.directusUrl) {
+            core_1.ux.error('Directus URL is required for programmatic mode.');
+        }
+        if (!flags.directusToken && (!flags.userEmail || !flags.userPassword)) {
+            core_1.ux.error('Either Directus token or email and password are required for programmatic mode.');
+        }
+        if (!flags.templateLocation) {
+            core_1.ux.error('Template location is required for programmatic mode.');
+        }
+    }
 }
 ApplyCommand.description = 'Apply a template to a blank Directus instance.';
 ApplyCommand.examples = [
@@ -215,20 +278,18 @@ ApplyCommand.examples = [
 ApplyCommand.flags = {
     content: core_1.Flags.boolean({
         allowNo: true,
-        default: templateFlagsDefault,
+        default: undefined,
         description: 'Load Content (data)',
-        relationships: [
-            { flags: ['schema', 'files'], type: 'all' },
-        ],
     }),
     dashboards: core_1.Flags.boolean({
         allowNo: true,
-        default: templateFlagsDefault,
+        default: undefined,
         description: 'Load Dashboards (dashboards, panels)',
     }),
     directusToken: core_1.Flags.string({
         description: 'Token to use for the Directus instance',
         env: 'TARGET_DIRECTUS_TOKEN',
+        exclusive: ['userEmail', 'userPassword'],
     }),
     directusUrl: core_1.Flags.string({
         description: 'URL of the Directus instance to apply the template to',
@@ -236,17 +297,17 @@ ApplyCommand.flags = {
     }),
     extensions: core_1.Flags.boolean({
         allowNo: true,
-        default: templateFlagsDefault,
+        default: undefined,
         description: 'Load Extensions',
     }),
     files: core_1.Flags.boolean({
         allowNo: true,
-        default: templateFlagsDefault,
+        default: undefined,
         description: 'Load Files (files, folders)',
     }),
     flows: core_1.Flags.boolean({
         allowNo: true,
-        default: templateFlagsDefault,
+        default: undefined,
         description: 'Load Flows (operations, flows)',
     }),
     partial: core_1.Flags.boolean({
@@ -256,7 +317,7 @@ ApplyCommand.flags = {
     }),
     permissions: core_1.Flags.boolean({
         allowNo: true,
-        default: templateFlagsDefault,
+        default: undefined,
         description: 'Loads permissions data. Collections include: directus_roles, directus_policies, directus_access, directus_permissions.',
         summary: 'Load permissions (roles, policies, access, permissions)',
     }),
@@ -268,12 +329,12 @@ ApplyCommand.flags = {
     }),
     schema: core_1.Flags.boolean({
         allowNo: true,
-        default: templateFlagsDefault,
+        default: undefined,
         description: 'Load schema (collections, relations)',
     }),
     settings: core_1.Flags.boolean({
         allowNo: true,
-        default: templateFlagsDefault,
+        default: undefined,
         description: 'Load settings (project settings, translations, presets)',
     }),
     templateLocation: core_1.Flags.string({
@@ -289,20 +350,22 @@ ApplyCommand.flags = {
         options: ['community', 'local', 'github'],
         summary: 'Type of template to apply. Options: community, local, github.',
     }),
+    userEmail: core_1.Flags.string({
+        dependsOn: ['userPassword'],
+        description: 'Email for Directus authentication',
+        env: 'TARGET_DIRECTUS_EMAIL',
+        exclusive: ['directusToken'],
+    }),
+    userPassword: core_1.Flags.string({
+        dependsOn: ['userEmail'],
+        description: 'Password for Directus authentication',
+        env: 'TARGET_DIRECTUS_PASSWORD',
+        exclusive: ['directusToken'],
+    }),
     users: core_1.Flags.boolean({
         allowNo: true,
-        default: templateFlagsDefault,
+        default: undefined,
         description: 'Load users',
-        relationships: [
-            { flags: ['permissions'], type: 'all' },
-        ],
     }),
 };
 exports.default = ApplyCommand;
-function templateFlagsDefault({ flags }) {
-    // If programmatic is true, and partial is not set, return true
-    if (flags.programmatic && !flags.partial) {
-        return true;
-    }
-    return false;
-}

package/dist/commands/extract.d.ts

@@ -8,6 +8,8 @@ export default class ExtractCommand extends Command {
         programmatic: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         templateLocation: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         templateName: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        userEmail: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        userPassword: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
     private extractTemplate;

package/dist/commands/extract.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const sdk_1 = require("@directus/sdk");
 const core_1 = require("@oclif/core");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
 const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const slugify_1 = tslib_1.__importDefault(require("slugify"));
@@ -34,7 +35,7 @@ class ExtractCommand extends core_1.Command {
             core_1.ux.error(`Failed to create directory or write files: ${error.message}`);
         }
         core_1.ux.log(constants_1.SEPARATOR);
-        core_1.ux.action.start(`Extracting template - from ${flags.directusUrl} to ${directory}`);
+        core_1.ux.action.start(`Extracting template - ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, templateName)} from ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, flags.directusUrl)} to ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, directory)}`);
         await (0, extract_1.default)(directory);
         core_1.ux.action.stop();
         core_1.ux.log(constants_1.SEPARATOR);
@@ -44,25 +45,53 @@ class ExtractCommand extends core_1.Command {
     async initializeDirectusApi(flags) {
         sdk_2.api.initialize(flags.directusUrl);
         try {
-            sdk_2.api.setAuthToken(flags.directusToken);
+            if (flags.directusToken) {
+                await sdk_2.api.loginWithToken(flags.directusToken);
+            }
+            else if (flags.userEmail && flags.userPassword) {
+                await sdk_2.api.login(flags.userEmail, flags.userPassword);
+            }
             const response = await sdk_2.api.client.request((0, sdk_1.readMe)());
             core_1.ux.log(`-- Logged in as ${response.first_name} ${response.last_name}`);
         }
         catch {
-            (0, catch_error_1.default)('Invalid Directus token. Please check your credentials.', {
+            (0, catch_error_1.default)('-- Unable to authenticate with the provided credentials. Please check your credentials.', {
                 fatal: true,
             });
         }
     }
     async runInteractive(flags) {
-        const templateName = await core_1.ux.prompt('What is the name of the template?');
+        core_1.ux.styledHeader(core_1.ux.colorize(constants_1.DIRECTUS_PURPLE, 'Directus Template CLI - Extract'));
+        const templateName = await core_1.ux.prompt('What is the name of the template you would like to extract?');
         const directory = await core_1.ux.prompt("What directory would you like to extract the template to? If it doesn't exist, it will be created.", { default: `templates/${(0, slugify_1.default)(templateName, { lower: true, strict: true })}` });
-        core_1.ux.log(`You selected ${directory}`);
-        // Get Directus URL and token
+        core_1.ux.log(`You selected ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, directory)}`);
+        core_1.ux.log(constants_1.SEPARATOR);
+        // Get Directus URL
         const directusUrl = await (0, auth_1.getDirectusUrl)();
-        const directusToken = await (0, auth_1.getDirectusToken)(directusUrl);
         flags.directusUrl = directusUrl;
-        flags.directusToken = directusToken;
+        // Prompt for login method
+        const loginMethod = await inquirer_1.default.prompt([
+            {
+                choices: [
+                    { name: 'Directus Access Token', value: 'token' },
+                    { name: 'Email and Password', value: 'email' },
+                ],
+                default: 'token',
+                message: 'How do you want to log in?',
+                name: 'loginMethod',
+                type: 'list',
+            },
+        ]);
+        if (loginMethod.loginMethod === 'token') {
+            const directusToken = await (0, auth_1.getDirectusToken)(directusUrl);
+            flags.directusToken = directusToken;
+        }
+        else {
+            flags.userEmail = await core_1.ux.prompt('What is your email?');
+            flags.userPassword = await core_1.ux.prompt('What is your password?', { type: 'hide' });
+        }
+        core_1.ux.log(constants_1.SEPARATOR);
+        await this.initializeDirectusApi(flags);
         await this.extractTemplate(templateName, directory, flags);
     }
     async runProgrammatic(flags) {
@@ -72,8 +101,12 @@ class ExtractCommand extends core_1.Command {
         await this.extractTemplate(templateName, templateLocation, flags);
     }
     validateProgrammaticFlags(flags) {
-        if (!flags.directusUrl || !flags.directusToken) {
-            core_1.ux.error('Directus URL and token are required for programmatic mode.');
+        if (!flags.directusUrl) {
+            core_1.ux.error('Directus URL is required for programmatic mode.');
+        }
+        // We need either a token or email/password
+        if (!flags.directusToken && (!flags.userEmail || !flags.userPassword)) {
+            core_1.ux.error('Either Directus token or email and password are required for programmatic mode.');
         }
         if (!flags.templateLocation) {
             core_1.ux.error('Template location is required for programmatic mode.');
@@ -92,6 +125,7 @@ ExtractCommand.flags = {
     directusToken: core_1.Flags.string({
         description: 'Token to use for the Directus instance',
         env: 'SOURCE_DIRECTUS_TOKEN',
+        exclusive: ['userEmail', 'userPassword'],
     }),
     directusUrl: core_1.Flags.string({
         description: 'URL of the Directus instance to extract the template from',
@@ -113,5 +147,17 @@ ExtractCommand.flags = {
         description: 'Name of the template',
         env: 'TEMPLATE_NAME',
     }),
+    userEmail: core_1.Flags.string({
+        dependsOn: ['userPassword'],
+        description: 'Email for Directus authentication',
+        env: 'SOURCE_DIRECTUS_EMAIL',
+        exclusive: ['directusToken'],
+    }),
+    userPassword: core_1.Flags.string({
+        dependsOn: ['userEmail'],
+        description: 'Password for Directus authentication',
+        env: 'SOURCE_DIRECTUS_PASSWORD',
+        exclusive: ['directusToken'],
+    }),
 };
 exports.default = ExtractCommand;

package/dist/lib/extract/extract-access.js

@@ -2,9 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
+const constants_1 = require("../constants");
 const sdk_1 = require("../sdk");
+const catch_error_1 = tslib_1.__importDefault(require("../utils/catch-error"));
 const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
 async function extractAccess(dir) {
+    core_1.ux.action.start(core_1.ux.colorize(constants_1.DIRECTUS_PINK, 'Extracting access'));
     try {
         const response = await sdk_1.api.client.request(() => ({
             method: 'GET',
@@ -15,11 +18,10 @@ async function extractAccess(dir) {
         //   delete access.id
         // }
         await (0, write_to_file_1.default)('access', response, dir);
-        core_1.ux.log('Extracted access');
     }
     catch (error) {
-        core_1.ux.warn('Error extracting access:');
-        core_1.ux.warn(error.message);
+        (0, catch_error_1.default)(error);
     }
+    core_1.ux.action.stop();
 }
 exports.default = extractAccess;