@lightdash/cli 2.157.0 → 2.158.0

package/dist/index.js

@@ -4,7 +4,6 @@ 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"));
@@ -76,9 +75,8 @@ 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.');
+    if (value.trim() === '') {
+        throw new commander_1.InvalidArgumentError('Not a valid project UUID or slug.');
     }
     return value;
 }
@@ -139,7 +137,7 @@ ${styles.bold('Examples:')}
   ${styles.title('⚡')}️lightdash ${styles.bold('login')} http://localhost:3000 --email demo@lightdash.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')
+    .addOption(new commander_1.Option('--project <project uuid or slug>', 'Select a project by UUID or slug after login')
     .argParser(parseProjectArgument)
     .conflicts('skipProjectSelection'))
     .option('--email <email>', 'Login with email and password', undefined)
@@ -376,7 +374,7 @@ const downloadCommand = commander_1.program
     .option('-p, --path <path>', 'specify a custom path to download content', undefined)
     .option('--nested', 'organize downloads in nested folders by project and space (default: flat structure)', false)
     .option('--root-spaces', 'write new flat space definitions at the content root instead of spaces/ (legacy layout)', false)
-    .option('--project <project uuid>', 'specify a project UUID to download', parseProjectArgument, undefined)
+    .option('--project <project uuid or slug>', 'specify a project (UUID or slug) to download from', parseProjectArgument, undefined)
     .option('--skip-spaces', 'skip downloading space definitions and access', false)
     .option('--spaces-only', 'download only space definitions and access', false)
     .option('--skip-charts', 'skip downloading charts', false)
@@ -411,7 +409,7 @@ const uploadCommand = commander_1.program
     .option('--external-connections <slugs...>', 'specify external connection slugs to upload (enterprise)', refsArgument_1.parseRefsArgument, [])
     .option('--force', 'Force upload unchanged files and allow destructive virtual-view column changes', false)
     .option('-p, --path <path>', 'specify a custom path to upload content from', undefined)
-    .option('--project <project uuid>', 'specify a project UUID to upload', parseProjectArgument, undefined)
+    .option('--project <project uuid or slug>', 'specify a project (UUID or slug) to upload to', parseProjectArgument, undefined)
     .option('--skip-space-create', 'Skip space creation if it does not exist', false)
     .option('--skip-space-access', 'upload spaces without applying their access policies', false)
     .option('--skip-spaces', 'skip uploading space definitions and access', false)
@@ -450,7 +448,7 @@ appsProgram
     .option('--description <text>', 'Set the app description', '')
     .option('--slug <slug>', 'Override the app slug')
     .option('-p, --path <path>', 'Specify the Lightdash content root (default: ./lightdash)')
-    .option('--project <project uuid>', 'Specify the project the app will use', parseProjectArgument, undefined)
+    .option('--project <project uuid or slug>', 'Specify the project the app will use', parseProjectArgument, undefined)
     .option('-y, --assume-yes', 'approve npm package installation', false)
     .option('--verbose', undefined, false)
     .addHelpText('after', `\n${styles.bold('Examples:')}\n  ${styles.title('⚡')}️lightdash ${styles.bold('apps create "Revenue explorer"')} ${styles.secondary('-- creates ./lightdash/apps/revenue-explorer')}\n  ${styles.title('⚡')}️lightdash ${styles.bold('apps create "Radial gauge" --chart-type')} ${styles.secondary('-- creates a custom chart type at ./lightdash/apps/radial-gauge')}\n`)
@@ -458,7 +456,7 @@ appsProgram
 appsProgram
     .command('preview [path]')
     .description('Preview a downloaded data app locally against a real Lightdash instance, authenticated as you. Your credential stays in the CLI, behind a local proxy limited to data-app SDK routes.')
-    .option('--project <project uuid>', 'preview against a specific project (default: the projectUuid in lightdash-app.yml)')
+    .option('--project <project uuid or slug>', 'preview against a specific project by UUID or slug (default: the projectUuid in lightdash-app.yml)')
     .option('--url <url>', 'Lightdash server URL (default: your login config)')
     .option('--token <token>', 'API key / personal access token (default: your login config)')
     .option('-y, --assume-yes', 'assume yes to the dependency install prompts when node_modules is missing', false)
@@ -484,7 +482,7 @@ appsProgram
 commander_1.program
     .command('deploy')
     .description('Compiles and deploys a Lightdash project')
-    .option('--project <project uuid>', 'Project UUID to deploy to. Overrides the default project configured via `lightdash config set-project`')
+    .option('--project <project uuid or slug>', 'Project UUID or slug to deploy to. Overrides the default project configured via `lightdash config set-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)
@@ -534,7 +532,7 @@ ${styles.bold('Examples:')}
 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('--project <project uuid or slug>', 'Project UUID or slug 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)
@@ -599,7 +597,7 @@ commander_1.program
     .command('rename')
     .description('Rename models and fields on Lightdash content')
     .option('--verbose', undefined, false)
-    .option('-p, --project <project uuid>', 'specify a project UUID to rename', parseProjectArgument, undefined)
+    .option('-p, --project <project uuid or slug>', 'specify a project (UUID or slug) to rename in', 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)
@@ -612,7 +610,7 @@ commander_1.program
     .command('slug-update')
     .description('Rename a chart slug and update its local references')
     .option('--verbose', 'show verbose output', false)
-    .option('--project <project uuid>', 'specify a project UUID', parseProjectArgument, undefined)
+    .option('--project <project uuid or slug>', 'specify a project by UUID or slug', parseProjectArgument, undefined)
     .option('-p, --path <path>', 'specify the local content-as-code path to update', undefined)
     .option('--dry-run', 'preview the chart rename and local file changes without making changes', false)
     .requiredOption('--from <slug>', 'current content slug')
@@ -683,7 +681,7 @@ commander_1.program
     .description('Audit pre-aggregate hit/miss coverage for a dashboard (or every dashboard with --all)')
     .option('--dashboard <uuidOrSlug>', 'Dashboard UUID or slug (required unless --all is passed)')
     .option('--all', 'Audit every dashboard in the target project', false)
-    .option('--project <projectUuid>', 'Project UUID (defaults to LIGHTDASH_PROJECT_UUID env or config)')
+    .option('--project <project uuid or slug>', 'Project UUID or slug (defaults to LIGHTDASH_PROJECT_UUID env or config)')
     .option('--json', 'Emit machine-readable JSON instead of human output', false)
     .option('--fail-on-miss', 'Exit 1 if any eligible tile is a pre-aggregate miss (CI-friendly)', false)
     .option('--verbose', 'Expand the ineligible section in human output', false)
@@ -734,7 +732,7 @@ commander_1.program
     .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>', 'Lightdash project UUID to update (defaults to currently selected project)', undefined)
+    .option('--project <project uuid or slug>', 'Lightdash project UUID or slug 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)
@@ -744,7 +742,7 @@ commander_1.program
     .description('Export a deployed chart as a PNG image. The chart must already exist on the server.')
     .argument('<chart>', 'Chart UUID or slug')
     .requiredOption('-o, --output <file>', 'Output file path for the PNG image')
-    .option('--project <uuid>', 'Lightdash project UUID (defaults to the currently selected project)')
+    .option('--project <project uuid or slug>', 'Lightdash project UUID or slug (defaults to the currently selected project)')
     .option('--verbose', 'Show detailed output', false)
     .action(exportChartImage_1.exportChartImageHandler);
 commander_1.program

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "2.157.0",
+  "version": "2.158.0",
   "description": "Lightdash CLI tool",
   "license": "MIT",
   "repository": {
@@ -45,8 +45,8 @@
     "unique-names-generator": "4.7.1",
     "uuid": "11.1.1",
     "yaml": "2.8.3",
-    "@lightdash/common": "2.157.0",
-    "@lightdash/warehouses": "2.157.0"
+    "@lightdash/common": "2.158.0",
+    "@lightdash/warehouses": "2.158.0"
   },
   "devDependencies": {
     "@types/inquirer": "8.2.4",