@claryai/cli 0.1.0

package/dist/index.js

@@ -0,0 +1,581 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const commander_1 = require("commander");
+const uuid_1 = require("uuid");
+const env_1 = require("./env");
+const error_1 = require("./error");
+const globalState_1 = tslib_1.__importDefault(require("./globalState"));
+const compile_1 = require("./handlers/compile");
+const refresh_1 = require("./handlers/dbt/refresh");
+const run_1 = require("./handlers/dbt/run");
+const deploy_1 = require("./handlers/deploy");
+const diagnostics_1 = require("./handlers/diagnostics");
+const download_1 = require("./handlers/download");
+const exportChartImage_1 = require("./handlers/exportChartImage");
+const generate_1 = require("./handlers/generate");
+const generateExposures_1 = require("./handlers/generateExposures");
+const getProject_1 = require("./handlers/getProject");
+const installSkills_1 = require("./handlers/installSkills");
+const lint_1 = require("./handlers/lint");
+const listProjects_1 = require("./handlers/listProjects");
+const login_1 = require("./handlers/login");
+const preview_1 = require("./handlers/preview");
+const renameHandler_1 = require("./handlers/renameHandler");
+const runChart_1 = require("./handlers/runChart");
+const setProject_1 = require("./handlers/setProject");
+const setWarehouse_1 = require("./handlers/setWarehouse");
+const sql_1 = require("./handlers/sql");
+const validate_1 = require("./handlers/validate");
+const styles = tslib_1.__importStar(require("./styles"));
+// Trigger CLI tests
+// Suppress AWS SDK V2 warning, imported by snowflake SDK
+process.env.AWS_SDK_JS_SUPPRESS_MAINTENANCE_MODE_MESSAGE = "1";
+function parseIntArgument(value) {
+    const parsedValue = parseInt(value, 10);
+    if (Number.isNaN(parsedValue)) {
+        throw new commander_1.InvalidArgumentError("Not a number.");
+    }
+    return parsedValue;
+}
+function parseStartOfWeekArgument(value) {
+    const number = parseIntArgument(value);
+    if (number < 0 || number > 6) {
+        throw new commander_1.InvalidArgumentError("Not a valid number. Please use a number from 0 (Monday) to 6 (Sunday)");
+    }
+    return number;
+}
+function parseUseDbtListOption(value) {
+    if (value === undefined) {
+        return true;
+    }
+    return value.toLowerCase() !== "false";
+}
+function parseDisableTimestampConversionOption(value) {
+    if (value === undefined) {
+        return false;
+    }
+    return value.toLowerCase() === "true";
+}
+function parseProjectArgument(value) {
+    if (value === undefined) {
+        throw new commander_1.InvalidArgumentError("No project argument provided.");
+    }
+    const isValidUuid = (0, uuid_1.validate)(value);
+    if (!isValidUuid) {
+        throw new commander_1.InvalidArgumentError("Not a valid project UUID.");
+    }
+    return value;
+}
+commander_1.program
+    .version((0, installSkills_1.getVersionWithSkills)())
+    .name(styles.title("⚡️clary"))
+    .description("Developer tools for dbt and Clary.\nSee https://docs.getclary.com for more help and examples")
+    .option("--non-interactive", "Disable all interactive prompts. Commands fail with helpful error if required input is missing.")
+    .hook("preAction", (thisCommand) => {
+    const opts = thisCommand.opts();
+    if (opts.nonInteractive) {
+        globalState_1.default.setNonInteractive(true);
+    }
+})
+    .showHelpAfterError(styles.bold("Run ⚡️clary help [command] for more information"))
+    .addHelpText("after", `
+${styles.bold("Examples:")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} ${styles.secondary("-- generates .yml file for all dbt models")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} -s mymodel ${styles.secondary("-- generates .yml file for a single dbt model")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} -s model1 model2 ${styles.secondary("-- generates .yml for multiple dbt models")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} -s tag:sales ${styles.secondary("-- generates .yml for all dbt models tagged as sales")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} -s +mymodel ${styles.secondary("-- generates .yml for mymodel and all it's parents")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} --help ${styles.secondary('-- shows detailed help for the "generate" command')}
+  ${styles.title("⚡")}️clary ${styles.bold("dbt run")} ${styles.secondary("-- runs dbt for all models and updates .yml for all models")}
+  ${styles.title("⚡")}️clary ${styles.bold("dbt run")} -s model1 model2+ tag:dev ${styles.secondary("-- runs dbt for models and generates .yml for affected models")}
+  ${styles.title("⚡")}️clary ${styles.bold("dbt run")} --help ${styles.secondary('-- shows detailed help for the "dbt run" command')}
+  ${styles.title("⚡")}️clary ${styles.bold("compile")} ${styles.secondary("-- compiles Clary metrics and dimensions")}
+  ${styles.title("⚡")}️clary ${styles.bold("deploy")} ${styles.secondary("-- compiles and deploys Clary metrics to active project")}
+  ${styles.title("⚡")}️clary ${styles.bold("login https://clary.domain.com")} ${styles.secondary("-- logs in to a Clary instance")}
+`);
+// LOGIN
+commander_1.program
+    .command("login [url]")
+    .description("Logs in to a Clary instance")
+    .description('Logs in to a Clary instance using OAuth2 (opens browser). Use --token to bypass OAuth.\n\nURL is optional - if not provided, uses the last URL you logged into. URL can be flexible: single words like "app" become "https://app.getclary.com", protocol defaults to https, and paths are ignored.\n\n👀 See https://docs.getclary.com/guides/cli/cli-authentication for more help and examples')
+    .addHelpText("after", `
+${styles.bold("Examples:")}
+  ${styles.title("⚡")}️clary ${styles.bold("login")} ${styles.secondary("-- Uses previously saved URL (opens browser for OAuth)")}
+  ${styles.title("⚡")}️clary ${styles.bold("login")} app ${styles.secondary("-- Short form for https://app.getclary.com (opens browser for OAuth)")}
+  ${styles.title("⚡")}️clary ${styles.bold("login")} eu1 ${styles.secondary("-- Short form for https://eu1.getclary.com (opens browser for OAuth)")}
+  ${styles.title("⚡")}️clary ${styles.bold("login")} app.getclary.com ${styles.secondary("-- Adds https:// automatically (opens browser for OAuth)")}
+  ${styles.title("⚡")}️clary ${styles.bold("login")} https://custom.clary.domain/projects/123 ${styles.secondary("-- Strips path, uses https://custom.clary.domain (opens browser for OAuth)")}
+  ${styles.title("⚡")}️clary ${styles.bold("login")} http://localhost:3000 ${styles.secondary("-- Preserves http protocol for local development")}
+  ${styles.title("⚡")}️clary ${styles.bold("login")} --token 12345 ${styles.secondary("-- Logs in with API token using saved URL (bypasses OAuth)")}
+  ${styles.title("⚡")}️clary ${styles.bold("login")} http://localhost:3000 --email demo@getclary.com ${styles.secondary("-- Local dev only: prompts for password securely")}
+`)
+    .option("--token <token>", "Login with an API access token", undefined)
+    .addOption(new commander_1.Option("--project <project uuid>", "Select a project by UUID after login")
+    .argParser(parseProjectArgument)
+    .conflicts("skipProjectSelection"))
+    .option("--email <email>", "Login with email and password", undefined)
+    .option("--oauth-port <port>", "Port for the local OAuth callback server (default: random available port)", (value) => {
+    const port = parseInt(value, 10);
+    if (Number.isNaN(port) || port < 1 || port > 65535) {
+        throw new Error("Port must be a number between 1 and 65535");
+    }
+    return port;
+}, undefined)
+    .option("--verbose", undefined, false)
+    .action(login_1.login);
+// CONFIG
+const configProgram = commander_1.program
+    .command("config")
+    .description("Sets configuration");
+configProgram
+    .command("set-project")
+    .description("Choose project.\nSee https://docs.getclary.com/guides/cli/cli-authentication#set-active-project for more help and examples")
+    .option("--verbose", undefined, false)
+    .addOption(new commander_1.Option("--name <project_name>", "Set the project non-interactively by passing a project name."))
+    .addOption(new commander_1.Option("--uuid <project_uuid>", "Set the project non-interactively by passing a project uuid.").conflicts("name"))
+    .action(setProject_1.setProjectHandler);
+configProgram
+    .command("list-projects")
+    .description("List all projects in the organization (excludes preview projects)")
+    .option("--verbose", undefined, false)
+    .action(listProjects_1.listProjectsHandler);
+configProgram
+    .command("get-project")
+    .description("Show the currently selected project")
+    .option("--verbose", undefined, false)
+    .action(getProject_1.getProjectHandler);
+configProgram
+    .command("unset-project")
+    .description("Clear the currently selected project")
+    .option("--verbose", undefined, false)
+    .action(setProject_1.unsetProjectHandler);
+const dbtProgram = commander_1.program.command("dbt").description("Runs dbt commands");
+dbtProgram
+    .command("run")
+    .description("Runs dbt and then generates .yml for affected models")
+    .addHelpText("after", `
+${styles.bold("Examples:")}
+  ${styles.title("⚡")}️clary ${styles.bold("dbt run")} ${styles.secondary("-- run all models and generate .yml files")}
+  ${styles.title("⚡")}️clary ${styles.bold("dbt run")} -s mymodel ${styles.secondary("-- runs a single model and generates .yml")}
+  ${styles.title("⚡")}️clary ${styles.bold("dbt run")} -s model1 model2 ${styles.secondary("-- runs multiple models and generates .yml")}
+  ${styles.title("⚡")}️clary ${styles.bold("dbt run")} -s tag:sales ${styles.secondary('-- runs all models tagged as "sales" and generates .yml')}
+  ${styles.title("⚡")}️clary ${styles.bold("dbt run")} -s +mymodel ${styles.secondary("-- runs mymodel and its parents and generates .yml")}
+`)
+    .option("--project-dir <path>", "The directory of the dbt project", env_1.DEFAULT_DBT_PROJECT_DIR)
+    .option("--profiles-dir <path>", "The directory of the dbt profiles", env_1.DEFAULT_DBT_PROFILES_DIR)
+    .option("--profile <name>")
+    .option("-t, --target <target>")
+    .option("-x, --fail-fast")
+    .option("--threads <threads>")
+    .option("--no-version-check")
+    .option("-s, --select, <select> [selects...]")
+    .option("--state <state>")
+    .option("--defer", "dbt property. Resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--no-defer", "dbt property. Do not resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--favor-state", "dbt property. When deferring, prioritize node definitions from the --state directory.", undefined)
+    .option("--full-refresh")
+    .option("--exclude-meta", "exclude Clary metadata from the generated .yml", false)
+    .option("--verbose", undefined, false)
+    .option("-y, --assume-yes", "assume yes to prompts", false)
+    .option("-no, --assume-no", "assume no to prompts", false)
+    .option("--preserve-column-case", "preserve original casing of column names in generated schema files", false)
+    .action(run_1.dbtRunHandler);
+commander_1.program
+    .command("compile")
+    .description("Compiles Clary resources")
+    .option("--project-dir <path>", "The directory of the dbt project", env_1.DEFAULT_DBT_PROJECT_DIR)
+    .option("--profiles-dir <path>", "The directory of the dbt profiles", env_1.DEFAULT_DBT_PROFILES_DIR)
+    .option("--profile <name>", "The name of the profile to use (defaults to profile name in dbt_project.yml)", undefined)
+    .option("--target <name>", "target to use in profiles.yml file", undefined)
+    .option("--target-path <path>", "The target directory for dbt (overrides DBT_TARGET_PATH and dbt_project.yml)", undefined)
+    .option("--vars <vars>")
+    .option("--threads <number>")
+    .option("--no-version-check")
+    .option("-s, --select <models...>", "specify models (accepts dbt selection syntax)")
+    .option("-m, --models <models...>", "specify models (accepts dbt selection syntax)")
+    .option("--exclude <models...>")
+    .option("--selector <selector_name>")
+    .option("--state <state>")
+    .option("--full-refresh")
+    .option("--verbose", undefined, false)
+    .option("--skip-warehouse-catalog", "Skip fetch warehouse catalog and use types in yml", false)
+    .option("--skip-dbt-compile", "Skip `dbt compile` and deploy from the existing ./target/manifest.json", false)
+    .option("--defer", "dbt property. Resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--no-defer", "dbt property. Do not resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--favor-state", "dbt property. When deferring, prioritize node definitions from the --state directory.", undefined)
+    .option("--no-warehouse-credentials", "Compile without any warehouse credentials. Skips dbt compile + warehouse catalog")
+    .option("--use-dbt-list [true|false]", "Use `dbt list` instead of `dbt compile` to generate dbt manifest.json", parseUseDbtListOption, true)
+    .option("--disable-timestamp-conversion [true|false]", "Disable timestamp conversion to UTC for Snowflake warehouses. Only use this if your timestamp values are already in UTC.", parseDisableTimestampConversionOption, false)
+    .action(compile_1.compileHandler);
+commander_1.program
+    .command("preview")
+    .description("Creates a new preview project - waits for a keypress to stop")
+    .option("--name <preview name>", "Custom name for the preview. If a name is not provided, a unique, randomly generated name will be created.")
+    .option("--project-dir <path>", "The directory of the dbt project", env_1.DEFAULT_DBT_PROJECT_DIR)
+    .option("--profiles-dir <path>", "The directory of the dbt profiles", env_1.DEFAULT_DBT_PROFILES_DIR)
+    .option("--profile <name>", "The name of the profile to use (defaults to profile name in dbt_project.yml)", undefined)
+    .option("--target <name>", "target to use in profiles.yml file", undefined)
+    .option("--target-path <path>", "The target directory for dbt (overrides DBT_TARGET_PATH and dbt_project.yml)", undefined)
+    .option("--vars <vars>")
+    .option("--defer", "dbt property. Resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--no-defer", "dbt property. Do not resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--favor-state", "dbt property. When deferring, prioritize node definitions from the --state directory.", undefined)
+    .option("--threads <number>")
+    .option("--no-version-check")
+    .option("-s, --select <models...>", "specify models (accepts dbt selection syntax)")
+    .option("-m, --models <models...>", "specify models (accepts dbt selection syntax)")
+    .option("--exclude <models...>")
+    .option("--selector <selector_name>")
+    .option("--state <state>")
+    .option("--full-refresh")
+    .option("--verbose", undefined, false)
+    .option("--start-of-week <number>", "Specifies the first day of the week (used by week-related date functions). 0 (Monday) to 6 (Sunday)", parseStartOfWeekArgument)
+    .option("--skip-dbt-compile", "Skip `dbt compile` and deploy from the existing ./target/manifest.json", false)
+    .option("--skip-warehouse-catalog", "Skip fetch warehouse catalog and use types in yml", false)
+    .option("--use-dbt-list [true|false]", "Use `dbt list` instead of `dbt compile` to generate dbt manifest.json", parseUseDbtListOption, true)
+    .option("--ignore-errors", "Allows deploy with errors on compile", false)
+    .option("--table-configuration <prod|all>", `If set to 'prod' it will copy the table configuration from prod project`, "all")
+    .option("--skip-copy-content", "Skip copying content from the source project", false)
+    .option("--disable-timestamp-conversion [true|false]", "Disable timestamp conversion to UTC for Snowflake warehouses. Only use this if your timestamp values are already in UTC.", parseDisableTimestampConversionOption, false)
+    .option("--no-warehouse-credentials", "Create preview without warehouse credentials. Copies credentials from upstream project.")
+    .option("--organization-credentials <name>", "Use organization warehouse credentials with the specified name (Enterprise Edition feature)")
+    .option("--use-batched-deploy", "Use the new batched deploy feature to upload explores in batches", false)
+    .option("--batch-size <number>", "Number of explores to deploy in each batch (default: 50)", "50")
+    .option("--parallel-batches <number>", "Number of batches to send in parallel (default: 1, use higher values with caution)", "1")
+    .action(preview_1.previewHandler);
+commander_1.program
+    .command("start-preview")
+    .description("Creates a new preview project")
+    .option("--name [preview name]", "[required] Name for the preview project. If a preview project with this name already exists, it will be updated, otherwise it will create a new preview project ")
+    .option("--project-dir <path>", "The directory of the dbt project", env_1.DEFAULT_DBT_PROJECT_DIR)
+    .option("--profiles-dir <path>", "The directory of the dbt profiles", env_1.DEFAULT_DBT_PROFILES_DIR)
+    .option("--profile <name>", "The name of the profile to use (defaults to profile name in dbt_project.yml)", undefined)
+    .option("--target <name>", "target to use in profiles.yml file", undefined)
+    .option("--target-path <path>", "The target directory for dbt (overrides DBT_TARGET_PATH and dbt_project.yml)", undefined)
+    .option("--vars <vars>")
+    .option("--defer", "dbt property. Resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--no-defer", "dbt property. Do not resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--favor-state", "dbt property. When deferring, prioritize node definitions from the --state directory.", undefined)
+    .option("--threads <number>")
+    .option("--no-version-check")
+    .option("-s, --select <models...>", "specify models (accepts dbt selection syntax)")
+    .option("-m, --models <models...>", "specify models (accepts dbt selection syntax)")
+    .option("--exclude <models...>")
+    .option("--selector <selector_name>")
+    .option("--state <state>")
+    .option("--full-refresh")
+    .option("--verbose", undefined, false)
+    .option("--start-of-week <number>", "Specifies the first day of the week (used by week-related date functions). 0 (Monday) to 6 (Sunday)", parseStartOfWeekArgument)
+    .option("--skip-dbt-compile", "Skip `dbt compile` and deploy from the existing ./target/manifest.json", false)
+    .option("--skip-warehouse-catalog", "Skip fetch warehouse catalog and use types in yml", false)
+    .option("--use-dbt-list [true|false]", "Use `dbt list` instead of `dbt compile` to generate dbt manifest.json", parseUseDbtListOption, true)
+    .option("--ignore-errors", "Allows deploy with errors on compile", false)
+    .option("--table-configuration <prod|all>", `If set to 'prod' it will copy the table configuration from prod project`, "all")
+    .option("--skip-copy-content", "Skip copying content from the source project", false)
+    .option("--disable-timestamp-conversion [true|false]", "Disable timestamp conversion to UTC for Snowflake warehouses. Only use this if your timestamp values are already in UTC.", parseDisableTimestampConversionOption, false)
+    .option("--no-warehouse-credentials", "Create preview without warehouse credentials. Copies credentials from upstream project.")
+    .option("-y, --assume-yes", "assume yes to prompts", false)
+    .option("--use-batched-deploy", "Use the new batched deploy feature to upload explores in batches", false)
+    .option("--batch-size <number>", "Number of explores to deploy in each batch (default: 50)", "50")
+    .option("--parallel-batches <number>", "Number of batches to send in parallel (default: 1, use higher values with caution)", "1")
+    .action(preview_1.startPreviewHandler);
+commander_1.program
+    .command("stop-preview")
+    .description("Deletes preview project")
+    .option("--name [preview name]", "[required] Name for the preview project to be deleted")
+    .option("--verbose", undefined, false)
+    .action(preview_1.stopPreviewHandler);
+commander_1.program
+    .command('download')
+    .description('Downloads charts and dashboards as code')
+    .option('--verbose', undefined, false)
+    .option('-c, --charts <charts...>', 'specify chart slugs, uuids, or urls to download', [])
+    .option('-d, --dashboards <dashboards...>', 'specify dashboard slugs, uuids or urls to download', [])
+    .option('-l, --language-map', 'generate a language maps for the downloaded charts and dashboards', false)
+    .option('-p, --path <path>', 'specify a custom path to download charts and dashboards', undefined)
+    .option('--nested', 'organize downloads in nested folders by project and space (default: flat structure)', false)
+    .option('--project <project uuid>', 'specify a project UUID to download', parseProjectArgument, undefined)
+    .option('--skip-spaces', 'skip writing space metadata files during download', false)
+    .action(download_1.downloadHandler);
+commander_1.program
+    .command("upload")
+    .description("Uploads charts and dashboards as code")
+    .option("--verbose", undefined, false)
+    .option("-c, --charts <charts...>", "specify chart slugs to force upload", [])
+    .option("-d, --dashboards <dashboards...>", "specify dashboard slugs to force upload", [])
+    .option("--force", "Force upload even if local files have not changed, use this when you want to upload files to a new project", false)
+    .option("-p, --path <path>", "specify a custom path to upload charts and dashboards from", undefined)
+    .option("--project <project uuid>", "specify a project UUID to upload", parseProjectArgument, undefined)
+    .option("--skip-space-create", "Skip space creation if it does not exist", false)
+    .option("--public", "Create new spaces as public instead of private", false)
+    .option("--concurrency <number>", "Number of parallel uploads (default: 1)", "1")
+    .option("--include-charts", "Include charts updates when uploading dashboards", false)
+    .option("--validate", "Validate charts and dashboards after upload", false)
+    .option("--gzip", "Enable gzip compression for request bodies", false)
+    .action(download_1.uploadHandler);
+commander_1.program
+    .command("deploy")
+    .description("Compiles and deploys a Clary project")
+    .option("--project-dir <path>", "The directory of the dbt project", env_1.DEFAULT_DBT_PROJECT_DIR)
+    .option("--profiles-dir <path>", "The directory of the dbt profiles", env_1.DEFAULT_DBT_PROFILES_DIR)
+    .option("--profile <name>", "The name of the profile to use (defaults to profile name in dbt_project.yml)", undefined)
+    .option("--target <name>", "target to use in profiles.yml file", undefined)
+    .option("--target-path <path>", "The target directory for dbt (overrides DBT_TARGET_PATH and dbt_project.yml)", undefined)
+    .option("--vars <vars>")
+    .option("--threads <number>")
+    .option("--no-version-check")
+    .option("-s, --select <models...>", "specify models (accepts dbt selection syntax)")
+    .option("-m, --models <models...>", "specify models (accepts dbt selection syntax)")
+    .option("--exclude <models...>")
+    .option("--selector <selector_name>")
+    .option("--state <state>")
+    .option("--full-refresh")
+    .option("--defer", "dbt property. Resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--no-defer", "dbt property. Do not resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--favor-state", "dbt property. When deferring, prioritize node definitions from the --state directory.", undefined)
+    .option("--verbose", undefined, false)
+    .option("--create [project_name]", "Create a new project. If a project name is not provided, you'll be prompted for one on creation.", undefined)
+    .option("--ignore-errors", "Allows deploy with errors on compile", false)
+    .option("--start-of-week <number>", "Specifies the first day of the week (used by week-related date functions). 0 (Monday) to 6 (Sunday)", parseStartOfWeekArgument)
+    .option("--skip-dbt-compile", "Skip `dbt compile` and deploy from the existing ./target/manifest.json", false)
+    .option("--skip-warehouse-catalog", "Skip fetch warehouse catalog and use types in yml", false)
+    .option("--use-dbt-list [true|false]", "Use `dbt list` instead of `dbt compile` to generate dbt manifest.json", parseUseDbtListOption, true)
+    .option("--no-warehouse-credentials", "Create project without warehouse credentials. Skips dbt compile + warehouse catalog")
+    .option("--organization-credentials <name>", "Use organization warehouse credentials with the specified name (Enterprise Edition feature)")
+    .option("--disable-timestamp-conversion [true|false]", "Disable timestamp conversion to UTC for Snowflake warehouses. Only use this if your timestamp values are already in UTC.", parseDisableTimestampConversionOption, false)
+    .option("-y, --assume-yes", "assume yes to prompts", false)
+    .option("--use-batched-deploy", "Use batched deploy for large projects (sends explores in batches)", false)
+    .option("--batch-size <number>", "Number of explores per batch (default: 50)", "50")
+    .option("--parallel-batches <number>", "Number of batches to send in parallel (default: 1, use higher values with caution)", "1")
+    .option("--gzip", "Enable gzip compression for request bodies", false)
+    .action(deploy_1.deployHandler);
+commander_1.program
+    .command("refresh")
+    .description("Refreshes Clary project with remote repository")
+    .addHelpText("after", `
+${styles.bold("Examples:")}
+  ${styles.title("⚡")}️clary ${styles.bold("refresh")}
+`)
+    .option("--verbose", undefined, false)
+    .action(refresh_1.refreshHandler);
+commander_1.program
+    .command("validate")
+    .description("Validates a project")
+    .option("--project <project uuid>", "Project UUID to validate, if not provided, the last preview will be used")
+    .option("--verbose", undefined, false)
+    .option("--project-dir <path>", "The directory of the dbt project", env_1.DEFAULT_DBT_PROJECT_DIR)
+    .option("--profiles-dir <path>", "The directory of the dbt profiles", env_1.DEFAULT_DBT_PROFILES_DIR)
+    .option("--profile <name>", "The name of the profile to use (defaults to profile name in dbt_project.yml)", undefined)
+    .option("--target <name>", "target to use in profiles.yml file", undefined)
+    .option("--vars <vars>")
+    .option("--threads <number>")
+    .option("--no-version-check")
+    .option("--preview", "Validate the last preview if available", false)
+    .option("-s, --select <models...>", "specify models (accepts dbt selection syntax)")
+    .option("-m, --models <models...>", "specify models (accepts dbt selection syntax)")
+    .option("--exclude <models...>")
+    .option("--selector <selector_name>")
+    .option("--state <state>")
+    .option("--full-refresh")
+    .option("--verbose", undefined, false)
+    .option("--skip-dbt-compile", "Skip `dbt compile` and deploy from the existing ./target/manifest.json", false)
+    .option("--skip-warehouse-catalog", "Skip fetch warehouse catalog and use types in yml", false)
+    .option("--use-dbt-list [true|false]", "Use `dbt list` instead of `dbt compile` to generate dbt manifest.json", parseUseDbtListOption, true)
+    .option("--disable-timestamp-conversion [true|false]", "Disable timestamp conversion to UTC for Snowflake warehouses. Only use this if your timestamp values are already in UTC.", parseDisableTimestampConversionOption, false)
+    .option("--show-chart-configuration-warnings", "Show chart configuration warnings (e.g., unused dimensions). These are hidden by default.", false)
+    .addOption(new commander_1.Option("--only <elems...>", "Specify project elements to validate")
+    .choices(Object.values(common_1.ValidationTarget))
+    .default(Object.values(common_1.ValidationTarget)))
+    .action(validate_1.validateHandler);
+commander_1.program
+    .command("generate")
+    .description("Generates a new schema.yml file for model")
+    .addHelpText("after", `
+${styles.bold("Examples:")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} ${styles.secondary("-- generates .yml file for all dbt models")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} -s mymodel ${styles.secondary("-- generates .yml file for a single dbt model")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} -s model1 model2 ${styles.secondary("-- generates .yml for multiple dbt models")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} -s tag:sales ${styles.secondary("-- generates .yml for all dbt models tagged as sales")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate")} -s +mymodel ${styles.secondary("-- generates .yml for mymodel and all it's parents")}
+`)
+    .option("-s, --select <models...>", "specify models (accepts dbt selection syntax)")
+    .option("-e, --exclude <models...>", "specify models (accepts dbt selection syntax)")
+    .option("-m, --models <models...>", "specify models (accepts dbt selection syntax)")
+    .option("--project-dir <path>", "The directory of the dbt project", env_1.DEFAULT_DBT_PROJECT_DIR)
+    .option("--profiles-dir <path>", "The directory of the dbt profiles", env_1.DEFAULT_DBT_PROFILES_DIR)
+    .option("--profile <name>", "The name of the profile to use (defaults to profile name in dbt_project.yml)", undefined)
+    .option("--target <name>", "target to use in profiles.yml file", undefined)
+    .option("--target-path <path>", "The target directory for dbt (overrides DBT_TARGET_PATH and dbt_project.yml)", undefined)
+    .option("--vars <vars>")
+    .option("-y, --assume-yes", "assume yes to prompts", false)
+    .option("--skip-existing", "skip files that already exist", false)
+    .option("--exclude-meta", "exclude Clary metadata from the generated .yml", false)
+    .option("--preserve-column-case", "preserve original casing of column names in generated schema files", false)
+    .option("--verbose", undefined, false)
+    .action(generate_1.generateHandler);
+commander_1.program
+    .command("rename")
+    .description("Rename models and fields on Clary content")
+    .option("--verbose", undefined, false)
+    .option("-p, --project <project uuid>", "specify a project UUID to rename", parseProjectArgument, undefined)
+    .option("-m, --model <model>", "When renaming a field, specify which model the field belongs to", undefined)
+    .option("-y, --assume-yes", "assume yes to prompts", false)
+    .requiredOption("-t, --type <type>", "model or field", common_1.RenameType.MODEL)
+    .requiredOption("--from <from>", "Name to replace from", undefined)
+    .requiredOption("--to <to>", "Name to replace to", undefined)
+    .option("--dry-run", "Test the rename, no changes will be made", false)
+    .option("--list", "List all charts and dashboards that are renamed", false)
+    .action(renameHandler_1.renameHandler);
+commander_1.program
+    .command("generate-exposures")
+    .description("[Experimental command] Generates a .yml file for Clary exposures")
+    .addHelpText("after", `
+${styles.bold("Examples:")}
+  ${styles.title("⚡")}️clary ${styles.bold("generate-exposures")} ${styles.secondary("-- generates .yml file for all clary exposures")}
+`)
+    .option("--project-dir <path>", "The directory of the dbt project", env_1.DEFAULT_DBT_PROJECT_DIR)
+    .option("--verbose", undefined, false)
+    .option("--output <path>", "The path where the output exposures YAML file will be written", undefined)
+    .action(generateExposures_1.generateExposuresHandler);
+commander_1.program
+    .command("diagnostics")
+    .description("Shows diagnostic information about the CLI environment")
+    .addHelpText("after", `
+${styles.bold("Examples:")}
+  ${styles.title("⚡")}️clary ${styles.bold("diagnostics")} ${styles.secondary("-- shows CLI version, Node.js version, and auth status")}
+  ${styles.title("⚡")}️clary ${styles.bold("diagnostics")} --dbt ${styles.secondary("-- includes dbt debug output")}
+  ${styles.title("⚡")}️clary ${styles.bold("diagnostics")} --dbt --project-dir ./my-dbt-project ${styles.secondary("-- runs dbt debug with custom project directory")}
+`)
+    .option("--dbt", "Include dbt debug information", false)
+    .option("--project-dir <path>", "The directory of the dbt project (used with --dbt flag)", env_1.DEFAULT_DBT_PROJECT_DIR)
+    .option("--profiles-dir <path>", "The directory of the dbt profiles (used with --dbt flag)", env_1.DEFAULT_DBT_PROFILES_DIR)
+    .option("--defer", "dbt property. Resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .option("--no-defer", "dbt property. Do not resolve unselected nodes by deferring to the manifest within the --state directory.", undefined)
+    .action(diagnostics_1.diagnosticsHandler);
+commander_1.program
+    .command("lint")
+    .description("Validates Clary Code files (models, charts, dashboards) against JSON schemas")
+    .addHelpText("after", `
+${styles.bold("Examples:")}
+  ${styles.title("⚡")}️clary ${styles.bold("lint")} ${styles.secondary("-- validates all Clary Code files in current directory")}
+  ${styles.title("⚡")}️clary ${styles.bold("lint")} --path ./chart.yml ${styles.secondary("-- validates a single chart file")}
+  ${styles.title("⚡")}️clary ${styles.bold("lint")} --path ./clary ${styles.secondary("-- validates files in a specific directory")}
+  ${styles.title("⚡")}️clary ${styles.bold("lint")} --verbose ${styles.secondary("-- shows detailed validation output")}
+  ${styles.title("⚡")}️clary ${styles.bold("lint")} --format json ${styles.secondary("-- outputs results in SARIF JSON format")}
+`)
+    .option("-p, --path <path>", "Path to a file or directory to lint (defaults to current directory)", undefined)
+    .option("--verbose", "Show detailed output", false)
+    .option("-f, --format <format>", "Output format: cli (default) or json (SARIF format)", "cli")
+    .action(lint_1.lintHandler);
+commander_1.program
+    .command("sql")
+    .description("Run raw SQL query against the warehouse using project credentials")
+    .argument("<query>", "SQL query to execute")
+    .requiredOption("-o, --output <file>", "Output file path for CSV results")
+    .option("--limit <number>", "Maximum rows to return from query", parseIntArgument)
+    .option("--page-size <number>", "Number of rows per page (default: 500, max: 5000)", parseIntArgument)
+    .option("--verbose", "Show detailed output", false)
+    .action(sql_1.sqlHandler);
+commander_1.program
+    .command("run-chart")
+    .description("Execute a chart YAML to verify the query runs")
+    .requiredOption("-p, --path <path>", "Path to chart YAML file")
+    .option("-o, --output <file>", "Output file path for CSV results")
+    .option("-l, --limit <number>", "Row limit for query", parseIntArgument)
+    .option("--page-size <number>", "Number of rows per page (default: 500)", parseIntArgument)
+    .option("--verbose", "Show detailed output", false)
+    .action(runChart_1.runChartHandler);
+commander_1.program
+    .command("set-warehouse")
+    .description("Update a project's warehouse connection from dbt profiles.yml. Use --assume-yes for non-interactive/CI usage. For organization-managed credentials, use the Clary UI.")
+    .option("--project-dir <path>", "The directory of the dbt project", env_1.DEFAULT_DBT_PROJECT_DIR)
+    .option("--profiles-dir <path>", "The directory of the dbt profiles", env_1.DEFAULT_DBT_PROFILES_DIR)
+    .option("--profile <name>", "The name of the profile to use (defaults to profile name in dbt_project.yml)", undefined)
+    .option("--target <name>", "target to use in profiles.yml file", undefined)
+    .option("--target-path <path>", "The target directory for dbt (overrides DBT_TARGET_PATH and dbt_project.yml)", undefined)
+    .option("--project <uuid>", "Clary project UUID to update (defaults to currently selected project)", undefined)
+    .option("--start-of-week <number>", "Specifies the first day of the week (used by week-related date functions). 0 (Monday) to 6 (Sunday)", parseStartOfWeekArgument)
+    .option("-y, --assume-yes", "assume yes to prompts", false)
+    .option("--verbose", "Show detailed output", false)
+    .action(setWarehouse_1.setWarehouseHandler);
+commander_1.program
+    .command("export-chart-image")
+    .description("Export a deployed chart as a PNG image. The chart must already exist on the server.")
+    .argument("<chart>", "Chart slug")
+    .requiredOption("-o, --output <file>", "Output file path for the PNG image")
+    .option("--verbose", "Show detailed output", false)
+    .action(exportChartImage_1.exportChartImageHandler);
+commander_1.program
+    .command('install-skills')
+    .description('Installs clary skills for AI coding assistants (Claude, Cursor, Codex)')
+    .addHelpText('after', `
+${styles.bold('Examples:')}
+  ${styles.title('⚡')}️clary ${styles.bold('install-skills')} ${styles.secondary('-- installs skills for Claude at git root (default)')}
+  ${styles.title('⚡')}️clary ${styles.bold('install-skills')} --agent cursor ${styles.secondary('-- installs skills for Cursor')}
+  ${styles.title('⚡')}️clary ${styles.bold('install-skills')} --global ${styles.secondary('-- installs skills globally to ~/.claude/skills/')}
+  ${styles.title('⚡')}️clary ${styles.bold('install-skills')} --agent codex --global ${styles.secondary('-- installs skills globally for Codex')}
+  ${styles.title('⚡')}️clary ${styles.bold('install-skills')} --path ./my-project ${styles.secondary('-- installs skills to a specific path')}
+  ${styles.title('⚡')}️clary ${styles.bold('install-skills')} --source my-org/clary-fork ${styles.secondary('-- installs skills from a custom GitHub repo')}
+
+${styles.bold("Installation paths:")}
+  ${styles.secondary("Project-level (default):")}
+    .claude/skills/    (Claude)
+    .cursor/skills/    (Cursor)
+    .codex/skills/     (Codex)
+
+  ${styles.secondary("Global (--global):")}
+    ~/.claude/skills/  (Claude)
+    ~/.cursor/skills/  (Cursor)
+    ~/.codex/skills/   (Codex)
+`)
+    .option('--verbose', 'Show detailed output', false)
+    .addOption(new commander_1.Option('--agent <agent>', 'Target agent for skill installation')
+    .choices(['claude', 'cursor', 'codex'])
+    .default('claude'))
+    .option('--global', 'Install skills globally to home directory instead of project', false)
+    .option('--path <path>', 'Override the install path (skills directory will be created inside)', undefined)
+    .option('--source <org/repo>', 'Override the GitHub repository to download skills from (default: clary/clary)', undefined)
+    .action(installSkills_1.installSkillsHandler);
+const errorHandler = (err) => {
+    // Use error message with fallback for safety
+    const errorMessage = (0, common_1.getErrorMessage)(err) || "An unexpected error occurred";
+    console.error(styles.error(errorMessage));
+    if (err.name === 'ForbiddenError' || err instanceof common_1.ForbiddenError) {
+        // For permission errors, show clear message with fallback
+        const permissionMessage = err.message || "You don't have permission to perform this action";
+        if (permissionMessage !== errorMessage) {
+            console.error(styles.error(permissionMessage));
+        }
+        console.error(`\n💡 Contact your Clary administrator to request project creation access or if you believe this is incorrect.\n`);
+    }
+    else if (err.name === 'AuthorizationError') {
+        console.error(`Looks like you did not authenticate or the personal access token expired.\n\n👀 See https://docs.getclary.com/guides/cli/cli-authentication for help and examples`);
+    }
+    else if (!(err instanceof common_1.LightdashError)) {
+        console.error(err);
+        if (err.stack) {
+            console.error(err.stack);
+        }
+        console.error('\nReport this issue with 1-click:\n');
+        console.error(`  🐛 https://github.com/claryai/clary-issues/issues/new?assignees=&labels=🐛+bug&template=bug_report.md&title=${encodeURIComponent(err.message)}`);
+    }
+    if (err.message.includes('ENOENT: dbt')) {
+        console.error(styles.error(`\n You must have dbt installed to use this command. See https://docs.getdbt.com/docs/core/installation for installation instructions`));
+    }
+    const diagnosticsHint = (0, error_1.getDiagnosticsHint)();
+    if (diagnosticsHint) {
+        console.error(diagnosticsHint);
+    }
+    if (env_1.NODE_VERSION.major !== env_1.OPTIMIZED_NODE_VERSION) {
+        console.warn(styles.warning(`⚠️ You are using Node.js version ${process.version}. Clary CLI is optimized for v${env_1.OPTIMIZED_NODE_VERSION} so you might experience issues.`));
+    }
+    process.exit(1);
+};
+const successHandler = () => {
+    console.error(`Done 🕶`);
+    process.exit(0);
+};
+commander_1.program.parseAsync().then(successHandler).catch(errorHandler);

package/dist/lightdash/loader.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Loader for Lightdash YAML model files
+ */
+import { type LightdashModel } from '@lightdash/common';
+/**
+ * Load a single Lightdash YAML model file
+ */
+export declare function loadLightdashModel(filePath: string): Promise<LightdashModel>;
+/**
+ * Find all Lightdash YAML model files in a directory
+ * Looks for files in models/ or lightdash/models/ directory that contain `type: model`
+ *
+ * This explicitly checks the YAML content for `type: model` (or versioned variants)
+ * to avoid false positives from other YAML files (e.g., content-as-code spaces).
+ */
+export declare function findLightdashModelFiles(projectDir: string): Promise<string[]>;
+/**
+ * Load all Lightdash YAML models from a project directory
+ */
+export declare function loadLightdashModels(projectDir: string): Promise<LightdashModel[]>;
+//# sourceMappingURL=loader.d.ts.map

package/dist/lightdash/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../../src/lightdash/loader.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAc,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAMpE;;GAEG;AACH,wBAAsB,kBAAkB,CACpC,QAAQ,EAAE,MAAM,GACjB,OAAO,CAAC,cAAc,CAAC,CA6BzB;AAuBD;;;;;;GAMG;AACH,wBAAsB,uBAAuB,CACzC,UAAU,EAAE,MAAM,GACnB,OAAO,CAAC,MAAM,EAAE,CAAC,CAqDnB;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CACrC,UAAU,EAAE,MAAM,GACnB,OAAO,CAAC,cAAc,EAAE,CAAC,CAwB3B"}