@claryai/cli 0.1.0

package/dist/handlers/exportChartImage.d.ts

@@ -0,0 +1,7 @@
+type ExportChartImageOptions = {
+    output: string;
+    verbose?: boolean;
+};
+export declare const exportChartImageHandler: (chartUuidOrSlug: string, options: ExportChartImageOptions) => Promise<void>;
+export {};
+//# sourceMappingURL=exportChartImage.d.ts.map

package/dist/handlers/exportChartImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exportChartImage.d.ts","sourceRoot":"","sources":["../../src/handlers/exportChartImage.ts"],"names":[],"mappings":"AAMA,KAAK,uBAAuB,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAChC,iBAAiB,MAAM,EACvB,SAAS,uBAAuB,KACjC,OAAO,CAAC,IAAI,CAkCd,CAAC"}

package/dist/handlers/exportChartImage.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportChartImageHandler = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
+const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const styles = tslib_1.__importStar(require("../styles"));
+const apiClient_1 = require("./dbt/apiClient");
+const exportChartImageHandler = async (chartUuidOrSlug, options) => {
+    globalState_1.default.setVerbose(options.verbose ?? false);
+    const spinner = globalState_1.default.startSpinner(`Exporting chart image for '${chartUuidOrSlug}'...`);
+    const imageUrl = await (0, apiClient_1.lightdashApi)({
+        method: 'POST',
+        url: `/api/v1/saved/${chartUuidOrSlug}/export`,
+        body: undefined,
+    });
+    if (!imageUrl) {
+        spinner.warn('No image URL returned');
+        return;
+    }
+    globalState_1.default.debug(`> Image URL: ${imageUrl}`);
+    spinner.text = 'Downloading image...';
+    const response = await (0, node_fetch_1.default)(imageUrl);
+    if (!response.ok) {
+        spinner.fail('Failed to download chart image');
+        throw new Error(`Failed to download image: ${response.status} ${response.statusText}`);
+    }
+    const arrayBuffer = await response.arrayBuffer();
+    await fs_1.promises.writeFile(options.output, Buffer.from(arrayBuffer));
+    spinner.succeed(`${styles.success('Success!')} Saved chart image to ${options.output}`);
+};
+exports.exportChartImageHandler = exportChartImageHandler;

package/dist/handlers/generate.d.ts

@@ -0,0 +1,13 @@
+import { CompileHandlerOptions } from './compile';
+type GenerateHandlerOptions = CompileHandlerOptions & {
+    select: string[] | undefined;
+    exclude: string[] | undefined;
+    models: string[] | undefined;
+    assumeYes: boolean;
+    excludeMeta: boolean;
+    skipExisting?: boolean;
+    preserveColumnCase: boolean;
+};
+export declare const generateHandler: (options: GenerateHandlerOptions) => Promise<void>;
+export {};
+//# sourceMappingURL=generate.d.ts.map

package/dist/handlers/generate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/handlers/generate.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAMlD,KAAK,sBAAsB,GAAG,qBAAqB,GAAG;IAClD,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7B,OAAO,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC9B,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF,eAAO,MAAM,eAAe,GAAU,SAAS,sBAAsB,kBA6KpE,CAAC"}

package/dist/handlers/generate.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateHandler = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const fs_1 = require("fs");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const path = tslib_1.__importStar(require("path"));
+const uuid_1 = require("uuid");
+const analytics_1 = require("../analytics/analytics");
+const context_1 = require("../dbt/context");
+const manifest_1 = require("../dbt/manifest");
+const models_1 = require("../dbt/models");
+const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const styles = tslib_1.__importStar(require("../styles"));
+const apiClient_1 = require("./dbt/apiClient");
+const compile_1 = require("./dbt/compile");
+const getDbtVersion_1 = require("./dbt/getDbtVersion");
+const getWarehouseClient_1 = tslib_1.__importDefault(require("./dbt/getWarehouseClient"));
+const generateHandler = async (options) => {
+    globalState_1.default.setVerbose(options.verbose);
+    await (0, apiClient_1.checkLightdashVersion)();
+    const executionId = (0, uuid_1.v4)();
+    if (options.select === undefined &&
+        options.exclude === undefined &&
+        !options.assumeYes) {
+        const answers = await inquirer_1.default.prompt([
+            {
+                type: 'confirm',
+                name: 'isConfirm',
+                message: 'Are you sure you want to generate .yml for all models in project?',
+            },
+        ]);
+        if (!answers.isConfirm) {
+            return;
+        }
+    }
+    const numModelsSelected = (options.select || options.models)?.length;
+    const startTime = Date.now();
+    await analytics_1.LightdashAnalytics.track({
+        event: 'generate.started',
+        properties: {
+            executionId,
+            trigger: 'generate',
+            numModelsSelected,
+        },
+    });
+    const absoluteProjectPath = path.resolve(options.projectDir);
+    const context = await (0, context_1.getDbtContext)({
+        projectDir: absoluteProjectPath,
+        targetPath: options.targetPath,
+    });
+    const profileName = options.profile || context.profileName;
+    const dbtVersion = await (0, getDbtVersion_1.getDbtVersion)();
+    const { warehouseClient } = await (0, getWarehouseClient_1.default)({
+        isDbtCloudCLI: dbtVersion.isDbtCloudCLI,
+        profilesDir: options.profilesDir,
+        profile: options.profile || context.profileName,
+        target: options.target,
+        startOfWeek: options.startOfWeek,
+    });
+    // When --target is explicitly set, run dbt ls to refresh the manifest
+    // so model schema/database/catalog reflect the correct target
+    if (options.target && !dbtVersion.isDbtCloudCLI) {
+        await (0, compile_1.dbtList)(options);
+    }
+    const manifest = await (0, manifest_1.loadManifest)({ targetDir: context.targetDir });
+    const models = (0, common_1.getModelsFromManifest)(manifest);
+    const compiledModels = await (0, models_1.getCompiledModels)(models, {
+        projectDir: dbtVersion.isDbtCloudCLI ? undefined : absoluteProjectPath,
+        profilesDir: dbtVersion.isDbtCloudCLI
+            ? undefined
+            : path.resolve(options.profilesDir),
+        profile: dbtVersion.isDbtCloudCLI ? undefined : profileName,
+        target: options.target,
+        select: options.select || options.models,
+        exclude: options.exclude,
+        vars: options.vars || undefined,
+    });
+    globalState_1.default.debug(`> Compiled models: ${compiledModels.length}`);
+    console.info(styles.info(`Generated .yml files:`));
+    for await (const compiledModel of compiledModels) {
+        const spinner = globalState_1.default.startSpinner(`  Generating .yml for model ${styles.bold(compiledModel.name)}`);
+        try {
+            const table = await (0, models_1.getWarehouseTableForModel)({
+                model: compiledModel,
+                warehouseClient,
+                preserveColumnCase: options.preserveColumnCase,
+            });
+            // Resolve dbt version for metadata structure
+            const resolvedDbtVersion = dbtVersion.versionOption === common_1.DbtVersionOptionLatest.LATEST
+                ? (0, common_1.getLatestSupportDbtVersion)()
+                : dbtVersion.versionOption;
+            globalState_1.default.debug(`Using detected dbt version ${resolvedDbtVersion} for metadata structure`);
+            const { updatedYml, outputFilePath } = await (0, models_1.findAndUpdateModelYaml)({
+                model: compiledModel,
+                table,
+                docs: manifest.docs,
+                includeMeta: !options.excludeMeta,
+                projectDir: absoluteProjectPath,
+                projectName: context.projectName,
+                assumeYes: options.assumeYes,
+                dbtVersion: resolvedDbtVersion,
+            });
+            try {
+                if (options.skipExisting) {
+                    try {
+                        await fs_1.promises.access(outputFilePath);
+                        spinner.warn(`  already exists ${styles.bold(compiledModel.name)}${styles.info(` ➡️  ${path.relative(process.cwd(), outputFilePath)} `)}`);
+                        // eslint-disable-next-line no-continue
+                        continue; // Skip this file if it already exists
+                    }
+                    catch {
+                        // File does not exist, we continue
+                    }
+                }
+                const outputDirPath = path.dirname(outputFilePath);
+                // Create a directory if it doesn't exist
+                try {
+                    await fs_1.promises.access(outputDirPath);
+                }
+                catch (error) {
+                    await fs_1.promises.mkdir(outputDirPath, { recursive: true });
+                }
+                await fs_1.promises.writeFile(outputFilePath, updatedYml.toString({
+                    quoteChar: '"',
+                }));
+            }
+            catch (e) {
+                const msg = (0, common_1.getErrorMessage)(e);
+                throw new common_1.ParseError(`Failed to write file ${outputFilePath}\n ${msg}`);
+            }
+            spinner.succeed(`  ${styles.bold(compiledModel.name)}${styles.info(` ➡️  ${path.relative(process.cwd(), outputFilePath)}`)}`);
+        }
+        catch (e) {
+            const msg = (0, common_1.getErrorMessage)(e);
+            await analytics_1.LightdashAnalytics.track({
+                event: 'generate.error',
+                properties: {
+                    executionId,
+                    trigger: 'generate',
+                    error: `${msg}`,
+                },
+            });
+            spinner.fail(`  Failed to generate ${compiledModel.name}.yml`);
+            throw e;
+        }
+    }
+    await analytics_1.LightdashAnalytics.track({
+        event: 'generate.completed',
+        properties: {
+            executionId,
+            trigger: 'generate',
+            numModelsSelected,
+            durationMs: Date.now() - startTime,
+        },
+    });
+};
+exports.generateHandler = generateHandler;

package/dist/handlers/generateExposures.d.ts

@@ -0,0 +1,8 @@
+type GenerateExposuresHandlerOptions = {
+    projectDir: string;
+    verbose: boolean;
+    output?: string;
+};
+export declare const generateExposuresHandler: (options: GenerateExposuresHandlerOptions) => Promise<void>;
+export {};
+//# sourceMappingURL=generateExposures.d.ts.map

package/dist/handlers/generateExposures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateExposures.d.ts","sourceRoot":"","sources":["../../src/handlers/generateExposures.ts"],"names":[],"mappings":"AAkBA,KAAK,+BAA+B,GAAG;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,eAAO,MAAM,wBAAwB,GACjC,SAAS,+BAA+B,kBA6G3C,CAAC"}

package/dist/handlers/generateExposures.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateExposuresHandler = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const fs_1 = require("fs");
+const yaml = tslib_1.__importStar(require("js-yaml"));
+const path = tslib_1.__importStar(require("path"));
+const uuid_1 = require("uuid");
+const analytics_1 = require("../analytics/analytics");
+const config_1 = require("../config");
+const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const styles = tslib_1.__importStar(require("../styles"));
+const apiClient_1 = require("./dbt/apiClient");
+const getDbtVersion_1 = require("./dbt/getDbtVersion");
+const generateExposuresHandler = async (options) => {
+    globalState_1.default.setVerbose(options.verbose);
+    await (0, apiClient_1.checkLightdashVersion)();
+    const executionId = (0, uuid_1.v4)();
+    const config = await (0, config_1.getConfig)();
+    if (!(config.context?.project && config.context.serverUrl)) {
+        throw new common_1.AuthorizationError(`No active Clary project. Run 'clary login --help'`);
+    }
+    const startTime = Date.now();
+    await analytics_1.LightdashAnalytics.track({
+        event: 'generate_exposures.started',
+        properties: {
+            executionId,
+        },
+    });
+    console.info(styles.warning(`This is an experimental feature and may change in future versions`));
+    // Log current project info
+    globalState_1.default.logProjectInfo(config);
+    const spinner = globalState_1.default.startSpinner(`  Generating Clary exposures .yml for project ${styles.bold(config.context.projectName || config.context.project)}`);
+    try {
+        const absoluteProjectPath = path.resolve(options.projectDir);
+        // Detect dbt version to determine format
+        const dbtVersionInfo = await (0, getDbtVersion_1.getDbtVersion)();
+        const isDbt110Plus = dbtVersionInfo.versionOption === common_1.DbtVersionOptionLatest.LATEST
+            ? true
+            : (0, common_1.isDbtVersion110OrHigher)(dbtVersionInfo.versionOption);
+        const exposures = await (0, apiClient_1.lightdashApi)({
+            method: 'GET',
+            url: `/api/v1/projects/${config.context.project}/dbt-exposures`,
+            body: undefined,
+        });
+        console.info(styles.info(`Found ${Object.keys(exposures).length} exposures`));
+        const outputFilePath = options.output ||
+            path.join(absoluteProjectPath, 'models', 'lightdash_exposures.yml');
+        // Transform exposures based on dbt version
+        const transformedExposures = Object.values(exposures).map(({ dependsOn, tags, ...rest }) => {
+            if (isDbt110Plus && tags) {
+                // For dbt 1.10+, move tags under config
+                return {
+                    ...rest,
+                    depends_on: dependsOn,
+                    config: {
+                        tags,
+                    },
+                };
+            }
+            // For older versions, keep tags at top level
+            return {
+                ...rest,
+                depends_on: dependsOn,
+                ...(tags ? { tags } : {}),
+            };
+        });
+        const updatedYml = {
+            version: 2,
+            exposures: transformedExposures,
+        };
+        const ymlString = yaml.dump(updatedYml, {
+            quotingType: '"',
+        });
+        await fs_1.promises.writeFile(outputFilePath, ymlString);
+        spinner.succeed(`  Generated exposures file in '${outputFilePath}'`);
+        await analytics_1.LightdashAnalytics.track({
+            event: 'generate_exposures.completed',
+            properties: {
+                executionId,
+                countExposures: Object.keys(exposures).length,
+                durationMs: Date.now() - startTime,
+            },
+        });
+    }
+    catch (e) {
+        await analytics_1.LightdashAnalytics.track({
+            event: 'generate_exposures.error',
+            properties: {
+                executionId,
+                trigger: 'generate',
+                error: `${(0, common_1.getErrorMessage)(e)}`,
+            },
+        });
+        spinner.fail(`  Failed to generate exposures file'`);
+        throw e;
+    }
+};
+exports.generateExposuresHandler = generateExposuresHandler;

package/dist/handlers/getProject.d.ts

@@ -0,0 +1,6 @@
+type GetProjectOptions = {
+    verbose: boolean;
+};
+export declare const getProjectHandler: (options: GetProjectOptions) => Promise<void>;
+export {};
+//# sourceMappingURL=getProject.d.ts.map

package/dist/handlers/getProject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getProject.d.ts","sourceRoot":"","sources":["../../src/handlers/getProject.ts"],"names":[],"mappings":"AAKA,KAAK,iBAAiB,GAAG;IACrB,OAAO,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAAU,SAAS,iBAAiB,kBAsCjE,CAAC"}

package/dist/handlers/getProject.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectHandler = void 0;
+const tslib_1 = require("tslib");
+const analytics_1 = require("../analytics/analytics");
+const config_1 = require("../config");
+const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const styles = tslib_1.__importStar(require("../styles"));
+const getProjectHandler = async (options) => {
+    const startTime = Date.now();
+    let success = true;
+    globalState_1.default.setVerbose(options.verbose);
+    try {
+        const config = await (0, config_1.getConfig)();
+        globalState_1.default.debug(`> Config: ${JSON.stringify(config)}`);
+        const projectUuid = config.context?.project;
+        const projectName = config.context?.projectName;
+        if (!projectUuid) {
+            console.error(styles.warning('No project set. Use `clary config set-project` to select a project.'));
+        }
+        else {
+            console.error(styles.bold('\nCurrent project:\n'));
+            console.error(`  Name: ${projectName || '(unknown)'}`);
+            console.error(`  UUID: ${projectUuid}`);
+            console.error('');
+        }
+    }
+    catch (e) {
+        success = false;
+        throw e;
+    }
+    finally {
+        await analytics_1.LightdashAnalytics.track({
+            event: 'command.executed',
+            properties: {
+                command: 'get-project',
+                durationMs: Date.now() - startTime,
+                success,
+            },
+        });
+    }
+};
+exports.getProjectHandler = getProjectHandler;

package/dist/handlers/installSkills.d.ts

@@ -0,0 +1,12 @@
+type AgentType = 'claude' | 'cursor' | 'codex';
+type InstallSkillsOptions = {
+    verbose: boolean;
+    agent: AgentType;
+    global: boolean;
+    path?: string;
+    source?: string;
+};
+export declare function getVersionWithSkills(): string;
+export declare const installSkillsHandler: (options: InstallSkillsOptions) => Promise<void>;
+export {};
+//# sourceMappingURL=installSkills.d.ts.map

package/dist/handlers/installSkills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"installSkills.d.ts","sourceRoot":"","sources":["../../src/handlers/installSkills.ts"],"names":[],"mappings":"AAqBA,KAAK,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE/C,KAAK,oBAAoB,GAAG;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,SAAS,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAoTF,wBAAgB,oBAAoB,IAAI,MAAM,CA8B7C;AAED,eAAO,MAAM,oBAAoB,GAC7B,SAAS,oBAAoB,KAC9B,OAAO,CAAC,IAAI,CAsFd,CAAC"}