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

package/README.md

@@ -4,21 +4,16 @@ 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 🙏)
+- 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.
+- ⚠️ 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.
-
-## Breaking Changes in v0.4.0
-
-- 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.
-
-## Usage
+- As of v0.5.0, the CLI is compatible with Directus 11 and up. 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.
@@ -26,24 +21,190 @@ Using the @latest tag ensures you're receiving the latest version of the package
 4. Run the following command on the terminal and follow the prompts.
 
 ```
-$ npx directus-template-cli@latest apply
+npx directus-template-cli@latest apply
+```
+
+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
+
+By default, the CLI will run in interactive 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. Defaults to `local`.
+- `--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
+
+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
 ```
 
-You can choose from our templates bundled with the CLI or you can also choose a template from a local directory.
+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.
+
+#### Using Environment Variables
+
+You can also pass flags as environment variables. This can be useful for CI/CD pipelines or when you want to avoid exposing sensitive information in command-line arguments. Here are the available environment variables:
+
+- `TARGET_DIRECTUS_URL`: Equivalent to `--directusUrl`
+- `TARGET_DIRECTUS_TOKEN`: Equivalent to `--directusToken`
+- `TARGET_DIRECTUS_EMAIL`: Equivalent to `--userEmail`
+- `TARGET_DIRECTUS_PASSWORD`: Equivalent to `--userPassword`
+- `TEMPLATE_LOCATION`: Equivalent to `--templateLocation`
+- `TEMPLATE_TYPE`: Equivalent to `--templateType`
+-
+
+### Existing Data
+
+You can apply a template to an existing Directus instance. This is nice because you can have smaller templates that you can "compose" for various use cases. The CLI tries to be smart about existing items in the target Directus instance. But mileage may vary depending on the size and complexity of the template and the existing instance.
+
+**System Collections**
+
+In most of the system collections (collections,roles, permissions, etc.), if an item with the same identifier already exists, it will be typically be SKIPPED vs overwritten.
 
-### Extracting a Template
+Exceptions:
+
+- directus_settings: The CLI attempts to merge the template's project settings with the existing settings in the target instance. Using the existing settings as a base and updating them with the values from the template. This should prevent overwriting branding, themes, and other customizations.
+
+**Your Collections:**
+
+For data in your own user-created collections, if an item has the same primary key, the data will be overwritten with the incoming data from 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
+
+By default, the CLI will run in interactive 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)
+
+#### Using Environment Variables
+
+Similar to the Apply command, you can use environment variables for the Extract command as well:
+
+- `SOURCE_DIRECTUS_URL`: Equivalent to `--directusUrl`
+- `SOURCE_DIRECTUS_TOKEN`: Equivalent to `--directusToken`
+- `SOURCE_DIRECTUS_EMAIL`: Equivalent to `--userEmail`
+- `SOURCE_DIRECTUS_PASSWORD`: Equivalent to `--userPassword`
+- `TEMPLATE_LOCATION`: Equivalent to `--templateLocation`
+
+## Logs
+
+The Directus Template CLI logs information to a file in the `.directus-template-cli/logs` directory.
+
+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
 
 This tool is licensed under the [MIT License](https://opensource.org/licenses/MIT).

package/dist/commands/apply.d.ts

@@ -17,13 +17,35 @@ 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>;
     };
+    /**
+     * MAIN
+     * Run the command
+     * @returns {Promise<void>} - Returns nothing
+     */
     run(): Promise<void>;
-    private initializeDirectusApi;
-    private redirectToDirectusPlus;
+    /**
+     * INTERACTIVE
+     * Run the command in interactive mode
+     * @param flags - The ApplyFlags
+     * @returns {Promise<void>} - Returns nothing
+     */
     private runInteractive;
+    /**
+     * PROGRAMMATIC
+     * Run the command in programmatic mode
+     * @param flags - The ApplyFlags
+     * @returns {Promise<void>} - Returns nothing
+     */
     private runProgrammatic;
+    /**
+     * INTERACTIVE
+     * Select a local template from the given directory
+     * @param localTemplateDir - The local template directory path
+     * @returns {Promise<Template>} - Returns the selected template
+     */
     private selectLocalTemplate;
-    private validateFlags;
 }

package/dist/commands/apply.js

@@ -1,45 +1,37 @@
 "use strict";
 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 = tslib_1.__importStar(require("inquirer"));
+const customFlags = tslib_1.__importStar(require("../flags/common"));
 const constants_1 = require("../lib/constants");
+const apply_flags_1 = require("../lib/load/apply-flags");
 const index_js_1 = tslib_1.__importDefault(require("../lib/load/index.js"));
-const sdk_2 = require("../lib/sdk");
 const auth_1 = require("../lib/utils/auth");
 const catch_error_1 = tslib_1.__importDefault(require("../lib/utils/catch-error"));
 const get_template_1 = require("../lib/utils/get-template");
 const logger_1 = require("../lib/utils/logger");
 const open_url_1 = tslib_1.__importDefault(require("../lib/utils/open-url"));
 class ApplyCommand extends core_1.Command {
-    // MAIN FUNCTION
+    /**
+     * MAIN
+     * Run the command
+     * @returns {Promise<void>} - Returns nothing
+     */
     async run() {
         const { flags } = await this.parse(ApplyCommand);
         const typedFlags = flags;
         await (typedFlags.programmatic ? this.runProgrammatic(typedFlags) : this.runInteractive(typedFlags));
     }
-    async initializeDirectusApi(flags) {
-        sdk_2.api.initialize(flags.directusUrl);
-        try {
-            sdk_2.api.setAuthToken(flags.directusToken);
-            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.', {
-                fatal: true,
-            });
-        }
-    }
-    redirectToDirectusPlus() {
-        (0, open_url_1.default)('https://directus.io/plus?utm_source=directus-template-cli&utm_content=apply-command');
-        core_1.ux.log('Redirecting to Directus website.');
-        core_1.ux.exit(0);
-    }
+    /**
+     * INTERACTIVE
+     * Run the command in interactive mode
+     * @param flags - The ApplyFlags
+     * @returns {Promise<void>} - Returns nothing
+     */
     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'));
+        const validatedFlags = (0, apply_flags_1.validateInteractiveFlags)(flags);
+        core_1.ux.styledHeader(core_1.ux.colorize(constants_1.DIRECTUS_PURPLE, 'Directus Template CLI - Apply'));
         const templateType = await inquirer.prompt([
             {
                 choices: [
@@ -79,16 +71,40 @@ class ApplyCommand extends core_1.Command {
                 break;
             }
             case 'directus-plus': {
-                this.redirectToDirectusPlus();
+                (0, open_url_1.default)('https://directus.io/plus?utm_source=directus-template-cli&utm_content=apply-command');
+                core_1.ux.log('Redirecting to Directus website.');
+                core_1.ux.exit(0);
             }
         }
         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 (0, auth_1.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);
@@ -98,8 +114,14 @@ class ApplyCommand extends core_1.Command {
             core_1.ux.exit(0);
         }
     }
+    /**
+     * PROGRAMMATIC
+     * Run the command in programmatic mode
+     * @param flags - The ApplyFlags
+     * @returns {Promise<void>} - Returns nothing
+     */
     async runProgrammatic(flags) {
-        const validatedFlags = this.validateFlags(flags);
+        const validatedFlags = (0, apply_flags_1.validateProgrammaticFlags)(flags);
         let template;
         switch (validatedFlags.templateType) {
             case 'community': {
@@ -121,7 +143,7 @@ class ApplyCommand extends core_1.Command {
                 });
             }
         }
-        await this.initializeDirectusApi(validatedFlags);
+        await (0, auth_1.initializeDirectusApi)(validatedFlags);
         const logMessage = `Applying template - ${template.templateName} to ${validatedFlags.directusUrl}`;
         core_1.ux.styledHeader(logMessage);
         logger_1.logger.log('info', logMessage);
@@ -131,6 +153,12 @@ class ApplyCommand extends core_1.Command {
         core_1.ux.info('Template applied successfully.');
         core_1.ux.exit(0);
     }
+    /**
+     * INTERACTIVE
+     * Select a local template from the given directory
+     * @param localTemplateDir - The local template directory path
+     * @returns {Promise<Template>} - Returns the selected template
+     */
     async selectLocalTemplate(localTemplateDir) {
         try {
             const templates = await (0, get_template_1.getInteractiveLocalTemplate)(localTemplateDir);
@@ -156,55 +184,6 @@ 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.');
-            }
-        }
-        const loadFlags = [
-            'content',
-            'dashboards',
-            'extensions',
-            'files',
-            'flows',
-            'permissions',
-            'schema',
-            'settings',
-            'users',
-        ];
-        const validatedFlags = { ...flags };
-        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.');
-                }
-            }
-        }
-        else {
-            // If not partial, set all flags to true
-            for (const flag of loadFlags) {
-                validatedFlags[flag] = true;
-            }
-        }
-        return validatedFlags;
-    }
 }
 ApplyCommand.description = 'Apply a template to a blank Directus instance.';
 ApplyCommand.examples = [
@@ -215,38 +194,29 @@ 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',
-    }),
-    directusUrl: core_1.Flags.string({
-        description: 'URL of the Directus instance to apply the template to',
-        env: 'TARGET_DIRECTUS_URL',
-    }),
+    directusToken: customFlags.directusToken,
+    directusUrl: customFlags.directusUrl,
     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,31 +226,22 @@ 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)',
     }),
-    programmatic: core_1.Flags.boolean({
-        char: 'p',
-        default: false,
-        description: 'Run in programmatic mode (non-interactive) for use cases such as CI/CD pipelines.',
-        summary: 'Run in programmatic mode',
-    }),
+    programmatic: customFlags.programmatic,
     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({
-        dependsOn: ['programmatic', 'templateType'],
-        description: 'Location of the template to apply',
-        env: 'TEMPLATE_LOCATION',
-    }),
+    templateLocation: customFlags.templateLocation,
     templateType: core_1.Flags.string({
         default: 'local',
         dependsOn: ['programmatic'],
@@ -289,20 +250,12 @@ ApplyCommand.flags = {
         options: ['community', 'local', 'github'],
         summary: 'Type of template to apply. Options: community, local, github.',
     }),
+    userEmail: customFlags.userEmail,
+    userPassword: customFlags.userPassword,
     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,11 +8,39 @@ 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>;
     };
+    /**
+     * Main run method for the ExtractCommand
+     * @returns {Promise<void>} - Returns nothing
+     */
     run(): Promise<void>;
+    /**
+     * Extracts the template to the specified directory
+     * @param {string} templateName - The name of the template to extract
+     * @param {string} directory - The directory to extract the template to
+     * @param {ExtractFlags} flags - The command flags
+     * @returns {Promise<void>} - Returns nothing
+     */
     private extractTemplate;
-    private initializeDirectusApi;
+    /**
+     * Runs the interactive mode for template extraction
+     * @param {ExtractFlags} flags - The command flags
+     * @returns {Promise<void>} - Returns nothing
+     */
     private runInteractive;
+    /**
+     * Runs the programmatic mode for template extraction
+     * @param {ExtractFlags} flags - The command flags
+     * @returns {Promise<void>} - Returns nothing
+     */
     private runProgrammatic;
+    /**
+     * Validates the flags for programmatic mode
+     * @param {ExtractFlags} flags - The command flags to validate
+     * @throws {Error} If required flags are missing
+     * @returns {void}
+     */
     private validateProgrammaticFlags;
 }