directus-template-cli 0.7.0-beta.13 → 0.7.0-beta.15

package/dist/commands/apply.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '@oclif/core';
-export default class ApplyCommand extends Command {
+import { BaseCommand } from './base.js';
+export default class ApplyCommand extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
@@ -20,6 +20,7 @@ export default class ApplyCommand extends Command {
         userEmail: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         userPassword: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         users: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        disableTelemetry: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     /**
      * MAIN

package/dist/commands/apply.js

@@ -1,4 +1,4 @@
-import { Command, Flags, ux } from '@oclif/core';
+import { Flags, ux } from '@oclif/core';
 import { text, select, password, log, intro } from '@clack/prompts';
 import * as path from 'pathe';
 import { animatedBunny } from '../lib/utils/animated-bunny.js';
@@ -13,7 +13,9 @@ import { getCommunityTemplates, getGithubTemplate, getInteractiveLocalTemplate,
 import { logger } from '../lib/utils/logger.js';
 import openUrl from '../lib/utils/open-url.js';
 import chalk from 'chalk';
-export default class ApplyCommand extends Command {
+import { BaseCommand } from './base.js';
+import { track, shutdown } from '../services/posthog.js';
+export default class ApplyCommand extends BaseCommand {
     static description = 'Apply a template to a blank Directus instance.';
     static examples = [
         '$ directus-template-cli apply',
@@ -86,6 +88,7 @@ export default class ApplyCommand extends Command {
             default: undefined,
             description: 'Load users',
         }),
+        disableTelemetry: customFlags.disableTelemetry,
     };
     /**
      * MAIN
@@ -177,8 +180,41 @@ export default class ApplyCommand extends Command {
         await initializeDirectusApi(validatedFlags);
         if (template) {
             // /* TODO: Replace with custom styledHeader function */ ux.styledHeader(ux.colorize(DIRECTUS_PURPLE, `Applying template - ${template.templateName} to ${directusUrl}`))
+            // Track start just before applying
+            if (!validatedFlags.disableTelemetry) {
+                await track({
+                    command: 'apply',
+                    lifecycle: 'start',
+                    distinctId: this.userConfig.distinctId,
+                    flags: {
+                        programmatic: false,
+                        templateName: template.templateName,
+                        templateType,
+                        // Include other relevant flags from validatedFlags if needed
+                        ...validatedFlags,
+                    },
+                    runId: this.runId,
+                    config: this.config,
+                });
+            }
             await apply(template.directoryPath, validatedFlags);
             ux.action.stop();
+            // Track completion before final messages/exit
+            if (!validatedFlags.disableTelemetry) {
+                await track({
+                    command: 'apply',
+                    lifecycle: 'complete',
+                    distinctId: this.userConfig.distinctId,
+                    flags: {
+                        templateName: template.templateName,
+                        templateType,
+                        ...validatedFlags,
+                    },
+                    runId: this.runId,
+                    config: this.config,
+                });
+                await shutdown();
+            }
             ux.stdout(SEPARATOR);
             log.warn(BSL_LICENSE_TEXT);
             ux.stdout('Template applied successfully.');
@@ -218,8 +254,40 @@ export default class ApplyCommand extends Command {
         const logMessage = `Applying template - ${template.templateName} to ${validatedFlags.directusUrl}`;
         // /* TODO: Replace with custom styledHeader function */ ux.styledHeader(logMessage)
         logger.log('info', logMessage);
+        // Track start just before applying
+        if (!validatedFlags.disableTelemetry) {
+            await track({
+                command: 'apply',
+                lifecycle: 'start',
+                distinctId: this.userConfig.distinctId,
+                flags: {
+                    programmatic: true,
+                    templateName: template.templateName,
+                    // Include other relevant flags from validatedFlags
+                    ...validatedFlags,
+                },
+                runId: this.runId,
+                config: this.config,
+            });
+        }
         await apply(template.directoryPath, validatedFlags);
         ux.action.stop();
+        // Track completion before final messages/exit
+        if (!validatedFlags.disableTelemetry) {
+            await track({
+                command: 'apply',
+                lifecycle: 'complete',
+                distinctId: this.userConfig.distinctId,
+                flags: {
+                    templateName: template.templateName,
+                    // Include other relevant flags from validatedFlags
+                    ...validatedFlags,
+                },
+                runId: this.runId,
+                config: this.config,
+            });
+            await shutdown();
+        }
         ux.stdout(SEPARATOR);
         ux.stdout('Template applied successfully.');
         // ux.exit(0)

package/dist/commands/base.d.ts

@@ -6,6 +6,7 @@ export declare abstract class BaseCommand extends Command {
     runId: string;
     userConfig: UserConfig;
     constructor(argv: string[], config: Config);
+    init(): Promise<void>;
     private loadUserConfig;
     /**
      * Save the current user configuration to disk

package/dist/commands/base.js

@@ -2,6 +2,7 @@ import { Command } from '@oclif/core';
 import { randomUUID } from 'node:crypto';
 import fs from 'node:fs';
 import path from 'pathe';
+import { setExecutionContext } from '../services/execution-context.js';
 export class BaseCommand extends Command {
     runId;
     userConfig = {};
@@ -10,6 +11,18 @@ export class BaseCommand extends Command {
         this.runId = randomUUID();
         this.loadUserConfig();
     }
+    async init() {
+        await super.init();
+        const { flags } = await this.parse({
+            flags: this.ctor.flags,
+            args: this.ctor.args,
+            strict: false,
+        });
+        setExecutionContext({
+            distinctId: this.userConfig.distinctId ?? undefined,
+            disableTelemetry: flags?.disableTelemetry ?? false,
+        });
+    }
     loadUserConfig() {
         try {
             const configPath = path.join(this.config.configDir, 'config.json');

package/dist/commands/extract.d.ts

@@ -1,4 +1,4 @@
-import { Command } from '@oclif/core';
+import { BaseCommand } from './base.js';
 export interface ExtractFlags {
     directusToken: string;
     directusUrl: string;
@@ -7,8 +7,9 @@ export interface ExtractFlags {
     templateName: string;
     userEmail: string;
     userPassword: string;
+    disableTelemetry?: boolean;
 }
-export default class ExtractCommand extends Command {
+export default class ExtractCommand extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
@@ -19,6 +20,7 @@ export default class ExtractCommand extends Command {
         templateName: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         userEmail: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         userPassword: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        disableTelemetry: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     /**
      * Main run method for the ExtractCommand

package/dist/commands/extract.js

@@ -1,5 +1,5 @@
 import { text, password, select, intro, log } from '@clack/prompts';
-import { Command, ux } from '@oclif/core';
+import { ux } from '@oclif/core';
 import slugify from '@sindresorhus/slugify';
 import chalk from 'chalk';
 import fs from 'node:fs';
@@ -7,11 +7,13 @@ import path from 'pathe';
 import * as customFlags from '../flags/common.js';
 import { DIRECTUS_PINK, DIRECTUS_PURPLE, SEPARATOR, BSL_LICENSE_TEXT } from '../lib/constants.js';
 import { animatedBunny } from '../lib/utils/animated-bunny.js';
+import { BaseCommand } from './base.js';
+import { track, shutdown } from '../services/posthog.js';
 import extract from '../lib/extract/index.js';
 import { getDirectusToken, getDirectusUrl, initializeDirectusApi, validateAuthFlags } from '../lib/utils/auth.js';
 import catchError from '../lib/utils/catch-error.js';
 import { generatePackageJsonContent, generateReadmeContent, } from '../lib/utils/template-defaults.js';
-export default class ExtractCommand extends Command {
+export default class ExtractCommand extends BaseCommand {
     static description = 'Extract a template from a Directus instance.';
     static examples = [
         '$ directus-template-cli extract',
@@ -25,6 +27,7 @@ export default class ExtractCommand extends Command {
         templateName: customFlags.templateName,
         userEmail: customFlags.userEmail,
         userPassword: customFlags.userPassword,
+        disableTelemetry: customFlags.disableTelemetry,
     };
     /**
      * Main run method for the ExtractCommand
@@ -43,6 +46,22 @@ export default class ExtractCommand extends Command {
      * @returns {Promise<void>} - Returns nothing
      */
     async extractTemplate(templateName, directory, flags) {
+        // Track start of extraction attempt
+        if (!flags.disableTelemetry) {
+            await track({
+                command: 'extract',
+                lifecycle: 'start',
+                distinctId: this.userConfig.distinctId,
+                flags: {
+                    templateName,
+                    templateLocation: directory,
+                    directusUrl: flags.directusUrl,
+                    programmatic: flags.programmatic,
+                },
+                runId: this.runId,
+                config: this.config,
+            });
+        }
         try {
             if (!fs.existsSync(directory)) {
                 fs.mkdirSync(directory, { recursive: true });
@@ -65,6 +84,23 @@ export default class ExtractCommand extends Command {
         ux.action.start(`Extracting template - ${ux.colorize(DIRECTUS_PINK, templateName)} from ${ux.colorize(DIRECTUS_PINK, flags.directusUrl)} to ${ux.colorize(DIRECTUS_PINK, directory)}`);
         await extract(directory);
         ux.action.stop();
+        // Track completion before final messages/exit
+        if (!flags.disableTelemetry) {
+            await track({
+                command: 'extract',
+                lifecycle: 'complete',
+                distinctId: this.userConfig.distinctId,
+                flags: {
+                    templateName,
+                    templateLocation: directory,
+                    directusUrl: flags.directusUrl,
+                    programmatic: flags.programmatic,
+                },
+                runId: this.runId,
+                config: this.config,
+            });
+            await shutdown();
+        }
         log.warn(BSL_LICENSE_TEXT);
         ux.stdout(SEPARATOR);
         ux.stdout('Template extracted successfully.');

package/dist/commands/init.d.ts

@@ -3,7 +3,7 @@ export interface InitFlags {
     frontend?: string;
     gitInit?: boolean;
     installDeps?: boolean;
-    overrideDir?: boolean;
+    overwriteDir?: boolean;
     template?: string;
     disableTelemetry?: boolean;
 }
@@ -22,7 +22,7 @@ export default class InitCommand extends BaseCommand {
         frontend: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         gitInit: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         installDeps: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        overrideDir: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        overwriteDir: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         template: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         disableTelemetry: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };

package/dist/commands/init.js

@@ -45,7 +45,9 @@ export default class InitCommand extends BaseCommand {
             default: true,
             description: 'Install dependencies automatically',
         }),
-        overrideDir: Flags.boolean({
+        overwriteDir: Flags.boolean({
+            aliases: ['overwrite-dir'],
+            allowNo: true,
             default: false,
             description: 'Override the default directory',
         }),
@@ -96,28 +98,31 @@ export default class InitCommand extends BaseCommand {
             }
             this.targetDir = dirResponse;
         }
-        if (fs.existsSync(this.targetDir) && !flags.overrideDir) {
-            const overrideDirResponse = await confirm({
+        if (fs.existsSync(this.targetDir) && !flags.overwriteDir) {
+            const overwriteDirResponse = await confirm({
                 message: 'Directory already exists. Would you like to overwrite it?',
+                initialValue: false,
             });
-            if (isCancel(overrideDirResponse)) {
+            if (isCancel(overwriteDirResponse) || overwriteDirResponse === false) {
                 cancel('Project creation cancelled.');
                 process.exit(0);
             }
-            if (overrideDirResponse) {
-                flags.overrideDir = true;
+            if (overwriteDirResponse) {
+                flags.overwriteDir = true;
             }
         }
-        // 1. Fetch available templates
+        // 1. Fetch available templates (now returns Array<{id: string, name: string, description?: string}>)
         const availableTemplates = await github.getTemplates();
         // 2. Prompt for template if not provided
-        let { template } = flags;
+        let { template } = flags; // This will store the chosen template ID
+        let chosenTemplateObject;
         if (!template) {
             const templateResponse = await select({
                 message: 'Which Directus backend template would you like to use?',
-                options: availableTemplates.map(template => ({
-                    label: template,
-                    value: template,
+                options: availableTemplates.map(tmpl => ({
+                    value: tmpl.id, // The value submitted will be the ID (directory name)
+                    label: tmpl.name, // Display the friendly name
+                    hint: tmpl.description, // Show the description as a hint
                 })),
             });
             if (isCancel(templateResponse)) {
@@ -126,22 +131,25 @@ export default class InitCommand extends BaseCommand {
             }
             template = templateResponse;
         }
-        // 3. Validate that the template exists, fetch subdirectories
-        let directories = await github.getTemplateDirectories(template);
+        // Find the chosen template object for potential future use (e.g., display name later)
+        chosenTemplateObject = availableTemplates.find(t => t.id === template);
+        // 3. Validate that the template exists in the available list
         const isDirectUrl = template?.startsWith('http');
-        while (!isDirectUrl && directories.length === 0) {
-            this.log(`Template "${template}" doesn't seem to exist in directus-labs/directus-starters.`);
+        // Validate against the 'id' property of the template objects
+        while (!isDirectUrl && !availableTemplates.some(t => t.id === template)) {
+            // Keep the warning message simple or refer back to the list shown in the prompt
+            clackLog.warn(`Template ID "${template}" is not valid. Please choose from the list provided or enter a direct GitHub URL.`);
             const templateNameResponse = await text({
-                message: 'Please enter a valid template name, or Ctrl+C to cancel:',
+                message: 'Please enter a valid template ID, a direct GitHub URL, or Ctrl+C to cancel:',
             });
             if (isCancel(templateNameResponse)) {
                 cancel('Project creation cancelled.');
                 process.exit(0);
             }
             template = templateNameResponse;
-            directories = await github.getTemplateDirectories(template);
+            chosenTemplateObject = availableTemplates.find(t => t.id === template); // Update chosen object after re-entry
         }
-        flags.template = template;
+        flags.template = template; // Ensure the flag stores the ID
         // Download the template to a temporary directory to read its configuration
         const tempDir = path.join(os.tmpdir(), `directus-template-${Date.now()}`);
         let chosenFrontend = flags.frontend;
@@ -220,7 +228,7 @@ export default class InitCommand extends BaseCommand {
                 gitInit: initGit,
                 installDeps,
                 template,
-                overrideDir: flags.overrideDir,
+                overwriteDir: flags.overwriteDir,
             },
         });
         // Track the command completion unless telemetry is disabled
@@ -234,7 +242,7 @@ export default class InitCommand extends BaseCommand {
                     gitInit: initGit,
                     installDeps,
                     template,
-                    overrideDir: flags.overrideDir,
+                    overwriteDir: flags.overwriteDir,
                 },
                 runId: this.runId,
                 config: this.config,

package/dist/lib/constants.d.ts

@@ -18,4 +18,7 @@ export declare const POSTHOG_PUBLIC_KEY = "phc_STopE6gj6LDIjYonVF7493kQJK8S4v0Xr
 export declare const POSTHOG_HOST = "https://us.i.posthog.com";
 export declare const DEFAULT_BRANCH = "main";
 export declare const BSL_LICENSE_URL = "https://directus.io/bsl";
-export declare const BSL_LICENSE_TEXT: string;
+export declare const BSL_EMAIL = "licensing@directus.io";
+export declare const BSL_LICENSE_HEADLINE = "You REQUIRE a license to use Directus if your organization has more than $5MM USD a year in revenue and/or funding.";
+export declare const BSL_LICENSE_TEXT = "For all organizations with less than $5MM USD a year in revenue and funding, Directus is free for personal projects, hobby projects and in production. This second group does not require a license. Directus is licensed under BSL 1.1.";
+export declare const BSL_LICENSE_CTA: string;

package/dist/lib/constants.js

@@ -1,5 +1,4 @@
 import chalk from 'chalk';
-import terminalLink from 'terminal-link';
 export const DIRECTUS_PURPLE = '#6644ff';
 export const DIRECTUS_PINK = '#FF99DD';
 export const SEPARATOR = '------------------';
@@ -20,6 +19,7 @@ export const POSTHOG_PUBLIC_KEY = 'phc_STopE6gj6LDIjYonVF7493kQJK8S4v0Xrl6YPr2z9
 export const POSTHOG_HOST = 'https://us.i.posthog.com';
 export const DEFAULT_BRANCH = 'main';
 export const BSL_LICENSE_URL = 'https://directus.io/bsl';
-const BSL_LINK = terminalLink(BSL_LICENSE_URL, BSL_LICENSE_URL);
-const BSL_MAILTO = terminalLink('sales-demo-with-evil-sales@directus.io', 'mailto:sales-demo-with-evil-sales@directus.io');
-export const BSL_LICENSE_TEXT = `You REQUIRE a license to use Directus if your organisation has more than $5MM USD a year in revenue and/or funding.\nFor all organizations with less than $5MM USD a year in revenue and funding, Directus is free for personal projects, hobby projects and in production. This second group does not require a license. \nDirectus is licensed under BSL1.1. Visit ${pinkText(BSL_LINK)} for more information or reach out to us at ${pinkText(BSL_MAILTO)}.`;
+export const BSL_EMAIL = 'licensing@directus.io';
+export const BSL_LICENSE_HEADLINE = 'You REQUIRE a license to use Directus if your organization has more than $5MM USD a year in revenue and/or funding.';
+export const BSL_LICENSE_TEXT = 'For all organizations with less than $5MM USD a year in revenue and funding, Directus is free for personal projects, hobby projects and in production. This second group does not require a license. Directus is licensed under BSL 1.1.';
+export const BSL_LICENSE_CTA = `Visit ${pinkText(BSL_LICENSE_URL)} for more information or reach out to us at ${pinkText(BSL_EMAIL)}.`;

package/dist/lib/init/index.js

@@ -7,19 +7,18 @@ import fs from 'node:fs';
 import { detectPackageManager, installDependencies } from 'nypm';
 import path from 'pathe';
 import dotenv from 'dotenv';
-import terminalLink from 'terminal-link';
 import ApplyCommand from '../../commands/apply.js';
 import { createDocker } from '../../services/docker.js';
 import catchError from '../utils/catch-error.js';
 import { createGigetString, parseGitHubUrl } from '../utils/parse-github-url.js';
 import { readTemplateConfig } from '../utils/template-config.js';
 import { DOCKER_CONFIG } from './config.js';
-import { BSL_LICENSE_TEXT, pinkText } from '../constants.js';
+import { BSL_LICENSE_TEXT, BSL_LICENSE_HEADLINE, BSL_LICENSE_CTA, pinkText } from '../constants.js';
 export async function init({ dir, flags }) {
     // Check target directory
-    const shouldForce = flags.overrideDir;
+    const shouldForce = flags.overwriteDir;
     if (fs.existsSync(dir) && !shouldForce) {
-        throw new Error('Directory already exists. Use --override-dir to override.');
+        throw new Error('Directory already exists. Use --overwrite-dir to override.');
     }
     // If template is a URL, we need to handle it differently
     const isDirectUrl = flags.template?.startsWith('http');
@@ -111,23 +110,33 @@ export async function init({ dir, flags }) {
             if (!isHealthy) {
                 throw new Error('Directus failed to become healthy');
             }
-            const templatePath = path.join(directusDir, 'template');
-            ux.stdout(`Attempting to apply template from: ${templatePath}`);
-            await ApplyCommand.run([
-                '--directusUrl=http://localhost:8055',
-                '-p',
-                '--userEmail=admin@example.com',
-                '--userPassword=d1r3ctu5',
-                `--templateLocation=${templatePath}`,
-            ]);
+            // Check if a template path is specified in the config and exists
+            let templatePath;
+            if (templateInfo?.config?.template && typeof templateInfo.config.template === 'string') {
+                templatePath = path.join(dir, templateInfo.config.template); // Path relative to root dir
+            }
+            if (templatePath && fs.existsSync(templatePath)) {
+                ux.stdout(`Applying template from: ${templatePath}`);
+                await ApplyCommand.run([
+                    `--directusUrl=${directusInfo.url || 'http://localhost:8055'}`,
+                    '-p',
+                    `--userEmail=${directusInfo.email}`,
+                    `--userPassword=${directusInfo.password}`,
+                    `--templateLocation=${templatePath}`,
+                ]);
+            }
+            else {
+                ux.stdout('Skipping backend template application.');
+            }
         }
+        // Detect package manager even if not installing dependencies
+        packageManager = await detectPackageManager(frontendDir);
         // Install dependencies if requested
         if (flags.installDeps) {
             const s = spinner();
             s.start('Installing dependencies');
             try {
                 if (fs.existsSync(frontendDir)) {
-                    packageManager = await detectPackageManager(frontendDir);
                     await installDependencies({
                         cwd: frontendDir,
                         packageManager,
@@ -151,14 +160,17 @@ export async function init({ dir, flags }) {
         // Finishing up
         const relativeDir = path.relative(process.cwd(), dir);
         const directusUrl = directusInfo.url ?? 'http://localhost:8055';
-        const directusText = `- Directus is running on ${terminalLink(directusUrl, directusUrl)}. You can login with the email: ${pinkText(directusInfo.email)} and password: ${pinkText(directusInfo.password)}. \n`;
+        const directusText = `- Directus is running on ${directusUrl}. \n`;
+        const directusLoginText = `- You can login with the email: ${pinkText(directusInfo.email)} and password: ${pinkText(directusInfo.password)}. \n`;
         const frontendText = flags.frontend ? `- To start the frontend, run ${pinkText(`cd ${flags.frontend}`)} and then ${pinkText(`${packageManager?.name} run dev`)}. \n` : '';
         const projectText = `- Navigate to your project directory using ${pinkText(`cd ${relativeDir}`)}. \n`;
         const readmeText = '- Review the \`./README.md\` file for more information and next steps.';
-        const nextSteps = `${directusText}${projectText}${frontendText}${readmeText}`;
+        const nextSteps = `${directusText}${directusLoginText}${projectText}${frontendText}${readmeText}`;
         note(nextSteps, 'Next Steps');
-        clackLog.warn(BSL_LICENSE_TEXT);
-        outro(`Problems or questions? Hop into the community on Discord at ${pinkText(terminalLink('https://directus.chat', 'https://directus.chat'))}`);
+        clackLog.warn(BSL_LICENSE_HEADLINE);
+        clackLog.info(BSL_LICENSE_TEXT);
+        clackLog.info(BSL_LICENSE_CTA);
+        outro(`Problems or questions? Hop into the community at ${pinkText('https://directus.chat')}`);
     }
     catch (error) {
         catchError(error, {

package/dist/lib/load/apply-flags.d.ts

@@ -15,7 +15,8 @@ export interface ApplyFlags {
     templateType: 'community' | 'github' | 'local';
     userEmail: string;
     userPassword: string;
-    users: boolean;
+    users?: boolean;
+    disableTelemetry?: boolean;
 }
 export declare const loadFlags: readonly ["content", "dashboards", "extensions", "files", "flows", "permissions", "schema", "settings", "users"];
 export declare function validateProgrammaticFlags(flags: ApplyFlags): ApplyFlags;

package/dist/lib/types.d.ts

@@ -5,7 +5,7 @@ export interface DirectusTemplateFrontend {
 export interface DirectusTemplateConfig {
     name: string;
     description: string;
-    template: string;
+    template: string | null;
     frontends: {
         [key: string]: DirectusTemplateFrontend;
     };

package/dist/lib/utils/catch-error.d.ts

@@ -3,7 +3,7 @@
  */
 interface ErrorHandlerOptions {
     /** Additional context to be included in the error log. */
-    context?: Record<string, any>;
+    context?: Record<string, unknown>;
     /** If true, the error will be treated as fatal and the process will exit. */
     fatal?: boolean;
     /** If true, the error will be logged to a file. */

package/dist/lib/utils/catch-error.js

@@ -1,6 +1,8 @@
 import { ux } from '@oclif/core';
 import { DirectusError } from '../sdk.js';
 import { logger } from '../utils/logger.js';
+import { captureException } from '../../services/posthog.js';
+import { getExecutionContext } from '../../services/execution-context.js';
 /**
  * Handles errors by formatting them and optionally logging to console and file.
  * @param error - The error to be handled.
@@ -9,6 +11,7 @@ import { logger } from '../utils/logger.js';
  */
 export default function catchError(error, options = {}) {
     const { context = {}, fatal = false, logToFile = true } = options;
+    const { distinctId, disableTelemetry } = getExecutionContext();
     let errorMessage;
     if (error instanceof DirectusError) {
         errorMessage = error.message;
@@ -19,6 +22,10 @@ export default function catchError(error, options = {}) {
     else {
         errorMessage = `Unknown error: ${JSON.stringify(error)}`;
     }
+    // Capture exception before logging/exiting
+    if (!disableTelemetry && distinctId) {
+        captureException({ error, distinctId, properties: { context } });
+    }
     // Format the error message with context if provided
     const formattedMessage = [
         errorMessage,

package/dist/lib/utils/parse-github-url.js

@@ -39,30 +39,59 @@ export function parseGitHubUrl(url) {
     if (!url) {
         throw new Error('URL is required');
     }
-    // Clean the URL first
     const cleanedUrl = cleanGitHubUrl(url);
-    // Handle full GitHub URLs
     if (cleanedUrl.includes('github.com')) {
         try {
             const parsed = new URL(cleanedUrl);
-            const parts = parsed.pathname.split('/').filter(Boolean);
-            if (parts.length < 2) {
-                throw new Error('Invalid GitHub URL format');
+            const pathParts = parsed.pathname.split('/').filter(Boolean);
+            if (pathParts.length < 2) {
+                throw new Error('Invalid GitHub URL format: Needs owner and repo.');
             }
-            const [owner, repo, ...rest] = parts;
-            const path = rest.length > 0 ? rest.join('/') : undefined;
-            const ref = parsed.searchParams.get('ref') || DEFAULT_BRANCH;
+            const owner = pathParts[0];
+            const repo = pathParts[1];
+            let ref = DEFAULT_BRANCH; // Default ref
+            let path;
+            // Check for /tree/ref/ or /blob/ref/ patterns
+            const treeIndex = pathParts.indexOf('tree');
+            const blobIndex = pathParts.indexOf('blob');
+            let refIndex = -1;
+            if (treeIndex > 1 && treeIndex + 1 < pathParts.length) {
+                refIndex = treeIndex + 1;
+            }
+            else if (blobIndex > 1 && blobIndex + 1 < pathParts.length) {
+                refIndex = blobIndex + 1;
+            }
+            if (refIndex !== -1) {
+                ref = pathParts[refIndex];
+                // Path is everything after the ref
+                path = pathParts.slice(refIndex + 1).join('/') || undefined;
+            }
+            else if (pathParts.length > 2) {
+                // If no tree/blob, but more parts exist, assume it's part of the path
+                // This handles cases like github.com/owner/repo/some/path without a specific ref marker
+                path = pathParts.slice(2).join('/') || undefined;
+                // If URL has an explicit ?ref= param, use that, otherwise keep default
+                ref = parsed.searchParams.get('ref') || ref;
+            }
+            else {
+                // No path, just owner/repo
+                ref = parsed.searchParams.get('ref') || ref;
+            }
+            // Ensure path is undefined if empty string
+            if (path === '')
+                path = undefined;
             return { owner, repo, path, ref };
         }
         catch (error) {
-            throw new Error(`Invalid GitHub URL: ${url}`);
+            throw new Error(`Invalid GitHub URL: ${url}. Error: ${error.message}`);
         }
     }
-    // Handle repository paths (owner/repo format)
+    // Handle repository paths (owner/repo/path format) without github.com
     const parts = cleanedUrl.split('/').filter(Boolean);
     if (parts.length >= 2) {
         const [owner, repo, ...rest] = parts;
         const path = rest.length > 0 ? rest.join('/') : undefined;
+        // Assume default branch for simple paths unless we add ref detection here too
         return { owner, repo, path, ref: DEFAULT_BRANCH };
     }
     // Handle simple template names using DEFAULT_REPO

package/dist/services/docker.js

@@ -1,4 +1,4 @@
-import { spinner } from '@clack/prompts';
+import { spinner, log } from '@clack/prompts';
 import { execa } from 'execa';
 import net from 'node:net';
 import { ux } from '@oclif/core';
@@ -88,24 +88,81 @@ async function checkDocker() {
         };
     }
 }
+/**
+ * Get the list of image names defined in the docker-compose file
+ * @param {string} cwd - The current working directory
+ * @returns {Promise<string[]>} - A list of image names
+ */
+async function getRequiredImagesFromCompose(cwd) {
+    try {
+        const { stdout } = await execa('docker', ['compose', 'config', '--images'], { cwd });
+        // stdout contains a list of image names, one per line
+        return stdout.split('\n').filter(img => img.trim() !== ''); // Filter out empty lines
+    }
+    catch (error) {
+        // Handle potential errors, e.g., compose file not found or invalid
+        log.error('Failed to get images from docker-compose file.');
+        catchError(error, {
+            context: { cwd, function: 'getRequiredImagesFromCompose' },
+            fatal: false, // Don't necessarily exit, maybe let startContainers handle it
+            logToFile: true,
+        });
+        return []; // Return empty list on error
+    }
+}
+/**
+ * Check if a list of Docker images exist locally
+ * @param {string[]} imageNames - An array of Docker image names (e.g., "postgres:16")
+ * @returns {Promise<boolean>} - True if all images exist locally, false otherwise
+ */
+async function checkImagesExist(imageNames) {
+    if (imageNames.length === 0) {
+        return true; // No images to check, technically they all "exist"
+    }
+    try {
+        // Use Promise.allSettled to check all images even if some commands fail
+        const results = await Promise.allSettled(imageNames.map(imageName => execa('docker', ['inspect', '--type=image', imageName])));
+        // Check if all inspect commands succeeded (exit code 0)
+        return results.every(result => result.status === 'fulfilled' && result.value.exitCode === 0);
+    }
+    catch (error) {
+        // This catch block might be redundant due to allSettled, but good for safety
+        log.error('Error checking for Docker images.');
+        catchError(error, {
+            context: { imageNames, function: 'checkImagesExist' },
+            fatal: false,
+            logToFile: true,
+        });
+        return false; // Assume images don't exist if there's an error checking
+    }
+}
 /**
  * Start Docker containers using docker compose
  * @param {string} cwd - The current working directory
  * @returns {Promise<void>} - Returns nothing
  */
 async function startContainers(cwd) {
+    const s = spinner();
     try {
         // Check if required ports are available
         await checkRequiredPorts();
-        const s = spinner();
-        s.start('Starting Docker containers');
-        return execa('docker', ['compose', 'up', '-d'], {
+        // Get required images from compose file
+        const requiredImages = await getRequiredImagesFromCompose(cwd);
+        const imagesExist = await checkImagesExist(requiredImages);
+        // Log a message if images need downloading
+        if (!imagesExist && requiredImages.length > 0) {
+            log.info('Required Docker image(s) are missing and will be downloaded.');
+        }
+        const startMessage = imagesExist || requiredImages.length === 0 ? 'Starting Docker containers...' : 'Downloading required Docker images...';
+        const endMessage = imagesExist || requiredImages.length === 0 ? 'Docker containers running!' : 'Docker images downloaded and containers started!';
+        s.start(startMessage); // Start spinner with the appropriate message
+        await execa('docker', ['compose', 'up', '-d'], {
             cwd,
-        }).then(() => {
-            s.stop('Docker containers running!');
         });
+        s.stop(endMessage); // Update spinner message on success
     }
     catch (error) {
+        s.stop('Error starting Docker containers.'); // Stop spinner on error
         catchError(error, {
             context: { cwd, function: 'startContainers' },
             fatal: true,

package/dist/services/execution-context.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Defines the structure for the execution context, holding telemetry information.
+ */
+export interface ExecutionContext {
+    distinctId?: string;
+    disableTelemetry?: boolean;
+}
+/**
+ * Sets the global execution context.
+ * This should be called early in the command lifecycle.
+ * @param context The context object containing distinctId and disableTelemetry status.
+ */
+export declare function setExecutionContext(context: ExecutionContext): void;
+/**
+ * Gets the currently set global execution context.
+ * @returns The current execution context.
+ */
+export declare function getExecutionContext(): ExecutionContext;

package/dist/services/execution-context.js

@@ -0,0 +1,20 @@
+// Module-level variable to hold the current context.
+// Initialize with default values (telemetry enabled, no distinctId yet).
+let currentContext = {
+    disableTelemetry: false,
+};
+/**
+ * Sets the global execution context.
+ * This should be called early in the command lifecycle.
+ * @param context The context object containing distinctId and disableTelemetry status.
+ */
+export function setExecutionContext(context) {
+    currentContext = context;
+}
+/**
+ * Gets the currently set global execution context.
+ * @returns The current execution context.
+ */
+export function getExecutionContext() {
+    return currentContext;
+}

package/dist/services/github.d.ts

@@ -5,14 +5,19 @@ interface GitHubUrlParts {
     ref?: string;
     repo: string;
 }
+export interface TemplateInfo {
+    id: string;
+    name: string;
+    description?: string;
+}
 export interface GitHubService {
     getTemplateDirectories(template: string, customUrl?: string): Promise<string[]>;
-    getTemplates(customUrl?: string): Promise<string[]>;
+    getTemplates(customUrl?: string): Promise<TemplateInfo[]>;
     parseGitHubUrl(url: string): GitHubUrlParts;
 }
 export declare function createGitHub(token?: string): {
     getTemplateDirectories: (template: string, customUrl?: string) => Promise<string[]>;
-    getTemplates: (customUrl?: string) => Promise<string[]>;
+    getTemplates: (customUrl?: string) => Promise<TemplateInfo[]>;
     parseGitHubUrl: typeof parseGitHubUrl;
 };
 export {};

package/dist/services/github.js

@@ -1,6 +1,7 @@
 import { Octokit } from '@octokit/rest';
 import { DEFAULT_REPO } from '../lib/constants.js';
 import { parseGitHubUrl } from '../lib/utils/parse-github-url.js';
+import { ux } from '@oclif/core';
 export function createGitHub(token) {
     const octokit = new Octokit({
         auth: token,
@@ -58,27 +59,112 @@ export function createGitHub(token) {
         }
     }
     /**
-     * Get the templates for a repository.
-     * @param customUrl - The custom URL to get the templates for.
-     * @returns The templates for the repository.
+     * Get the templates for a repository, including name and description from package.json.
+     * Ensures 'blank' template appears last if found.
+     * If a direct URL to a template directory is provided, attempt to fetch its package.json.
+     * @param customUrl - The custom URL or base repository URL to get the templates for.
+     * @returns The templates for the repository with details, sorted.
      */
     async function getTemplates(customUrl) {
-        // If customUrl is provided and it's a full repository URL, return it as the only template
+        // Handle direct URLs pointing to a specific template directory
         if (customUrl?.startsWith('http')) {
-            return [customUrl];
+            const parsed = parseGitHubUrl(customUrl);
+            let name = parsed.path?.split('/').pop() || parsed.repo;
+            let description;
+            const packageJsonPath = joinPath(parsed.path || '', 'package.json');
+            try {
+                const { data: packageJsonContent } = await octokit.rest.repos.getContent({
+                    owner: parsed.owner,
+                    repo: parsed.repo,
+                    path: packageJsonPath,
+                    ref: parsed.ref,
+                    mediaType: {
+                        format: 'raw',
+                    },
+                });
+                // getContent with mediaType: raw returns string directly
+                if (typeof packageJsonContent === 'string') {
+                    const packageJson = JSON.parse(packageJsonContent);
+                    const templateConfig = packageJson?.['directus:template'];
+                    if (templateConfig?.name) {
+                        name = templateConfig.name;
+                    }
+                    if (templateConfig?.description) {
+                        description = templateConfig.description;
+                    }
+                }
+            }
+            catch (error) {
+                // If package.json is missing or fails to parse, just use the default name derived from the URL.
+                // Don't warn here as it might be expected that a direct URL doesn't have this structure.
+                if (error.status !== 404) {
+                    // Log other errors if needed for debugging, but don't show to user unless verbose?
+                    console.error(`Error fetching package.json for direct URL ${customUrl}: ${error.message}`);
+                }
+            }
+            // Return a single item array for the direct URL case
+            return [{ id: customUrl, name, description }];
         }
         const repo = customUrl ? parseGitHubUrl(customUrl) : DEFAULT_REPO;
-        const { data } = await octokit.rest.repos.getContent({
+        const { data: rootContent } = await octokit.rest.repos.getContent({
             owner: repo.owner,
             path: repo.path || '',
             ref: repo.ref,
             repo: repo.repo,
         });
-        if (!Array.isArray(data))
+        if (!Array.isArray(rootContent))
             return [];
-        return data
-            .filter(item => item.type === 'dir')
-            .map(item => item.name);
+        const directories = rootContent.filter(item => item.type === 'dir');
+        // Fetch package.json for each directory concurrently
+        let templateInfos = await Promise.all(directories.map(async (dir) => {
+            const packageJsonPath = joinPath(repo.path || '', dir.path, 'package.json');
+            let name = dir.name;
+            let description;
+            try {
+                const { data: packageJsonContent } = await octokit.rest.repos.getContent({
+                    owner: repo.owner,
+                    repo: repo.repo,
+                    path: packageJsonPath,
+                    ref: repo.ref,
+                    mediaType: {
+                        format: 'raw',
+                    },
+                });
+                // getContent with mediaType: raw returns string directly
+                if (typeof packageJsonContent === 'string') {
+                    const packageJson = JSON.parse(packageJsonContent);
+                    const templateConfig = packageJson?.['directus:template'];
+                    if (templateConfig?.name) {
+                        name = templateConfig.name;
+                    }
+                    if (templateConfig?.description) {
+                        description = templateConfig.description;
+                    }
+                }
+            }
+            catch (error) {
+                // Handle cases where package.json is missing or fails to parse
+                if (error.status !== 404) {
+                    ux.warn(`Could not fetch or parse package.json for template "${dir.name}": ${error.message}`);
+                }
+            }
+            return {
+                id: dir.name,
+                name,
+                description,
+            };
+        }));
+        // Sort the templates to put "blank" last
+        templateInfos.sort((a, b) => {
+            const aIsBlank = a.id.toLowerCase() === 'blank' || a.name.toLowerCase() === 'blank';
+            const bIsBlank = b.id.toLowerCase() === 'blank' || b.name.toLowerCase() === 'blank';
+            if (aIsBlank && !bIsBlank)
+                return 1; // a comes AFTER b
+            if (!aIsBlank && bIsBlank)
+                return -1; // a comes BEFORE b
+            return a.name.localeCompare(b.name);
+        });
+        return templateInfos;
     }
     return {
         getTemplateDirectories,
@@ -86,3 +172,7 @@ export function createGitHub(token) {
         parseGitHubUrl,
     };
 }
+// Helper functions
+function joinPath(...segments) {
+    return segments.filter(Boolean).join('/');
+}

package/dist/services/posthog.d.ts

@@ -35,3 +35,16 @@ export declare function track({ lifecycle, distinctId, command, flags, runId, me
     properties?: Record<string, unknown>;
     debug?: boolean;
 }): void;
+/**
+ * Manually capture an exception in PostHog
+ * @param error The error object to capture
+ * @param distinctId The distinct ID for the user
+ * @param properties Optional additional properties to track
+ * @param debug Whether to log debug information
+ */
+export declare function captureException({ error, distinctId, properties, debug }: {
+    error: unknown;
+    distinctId: string;
+    properties?: Record<string, unknown>;
+    debug?: boolean;
+}): void;

package/dist/services/posthog.js

@@ -79,11 +79,37 @@ export function track({ lifecycle, distinctId, command, flags, runId, message, c
     phClient.capture({
         distinctId,
         event: `directus_template_cli.${command}.${lifecycle}`,
-        properties: eventProperties
+        properties: { eventProperties }
     });
     if (debug)
         ux.stdout('Event tracked successfully');
 }
+/**
+ * Manually capture an exception in PostHog
+ * @param error The error object to capture
+ * @param distinctId The distinct ID for the user
+ * @param properties Optional additional properties to track
+ * @param debug Whether to log debug information
+ */
+export function captureException({ error, distinctId, properties = {}, debug = false }) {
+    if (debug)
+        ux.stdout('Capturing exception...');
+    const phClient = getClient(debug);
+    const exceptionProperties = properties;
+    if (debug) {
+        ux.stdout('Sending exception data:');
+        ux.stdout(`Error: ${error}`);
+        ux.stdout(`Properties: ${JSON.stringify(exceptionProperties)}`);
+    }
+    try {
+        phClient.captureException(error, distinctId, properties);
+        if (debug)
+            ux.stdout('Exception captured successfully');
+    }
+    catch (captureError) {
+        ux.warn(`Failed to capture PostHog exception: ${captureError}`);
+    }
+}
 /**
  * Get environment info
  * @param config The config to get environment info from

package/oclif.manifest.json

@@ -159,6 +159,13 @@
           "name": "users",
           "allowNo": true,
           "type": "boolean"
+        },
+        "disableTelemetry": {
+          "description": "Disable telemetry",
+          "env": "DISABLE_TELEMETRY",
+          "name": "disableTelemetry",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -281,6 +288,13 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "disableTelemetry": {
+          "description": "Disable telemetry",
+          "env": "DISABLE_TELEMETRY",
+          "name": "disableTelemetry",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -341,10 +355,13 @@
           "allowNo": true,
           "type": "boolean"
         },
-        "overrideDir": {
+        "overwriteDir": {
+          "aliases": [
+            "overwrite-dir"
+          ],
           "description": "Override the default directory",
-          "name": "overrideDir",
-          "allowNo": false,
+          "name": "overwriteDir",
+          "allowNo": true,
           "type": "boolean"
         },
         "template": {
@@ -378,5 +395,5 @@
       ]
     }
   },
-  "version": "0.7.0-beta.13"
+  "version": "0.7.0-beta.15"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "directus-template-cli",
-  "version": "0.7.0-beta.13",
+  "version": "0.7.0-beta.15",
   "description": "CLI Utility for applying templates to a Directus instance.",
   "author": "bryantgillespie @bryantgillespie",
   "type": "module",
@@ -38,8 +38,7 @@
     "log-update": "^6.1.0",
     "nypm": "^0.6.0",
     "pathe": "^2.0.3",
-    "posthog-node": "^4.10.1",
-    "terminal-link": "^4.0.0"
+    "posthog-node": "^4.10.1"
   },
   "devDependencies": {
     "@directus/types": "^13.0.0",