@amplitude/wizard 1.0.0-beta.0 → 1.0.0-beta.1

package/dist/src/utils/setup-utils.d.ts

@@ -60,6 +60,17 @@ export declare function getPackageManager(options: Pick<WizardOptions, 'installD
     ci?: boolean;
 }): Promise<PackageManager>;
 export declare function isUsingTypeScript({ installDir, }: Pick<WizardOptions, 'installDir'>): boolean;
+/**
+ * Best-effort credentials for `--ci` when `--api-key` / AMPLITUDE_WIZARD_API_KEY
+ * is not set: project-local key (.env.local / keychain), then OAuth id token from
+ * ~/.ampli.json plus org/workspace from ampli.json (same resolution as interactive bootstrap).
+ */
+export declare function tryResolveCredentialsForCi(installDir: string): Promise<{
+    host: string;
+    projectApiKey: string;
+    accessToken: string;
+    cloudRegion: CloudRegion;
+} | null>;
 /**
  * Get project data for the wizard via Amplitude OAuth or CI API key.
  *

package/dist/src/utils/setup-utils.js

@@ -46,6 +46,7 @@ exports.tryGetPackageJson = tryGetPackageJson;
 exports.updatePackageDotJson = updatePackageDotJson;
 exports.getPackageManager = getPackageManager;
 exports.isUsingTypeScript = isUsingTypeScript;
+exports.tryResolveCredentialsForCi = tryResolveCredentialsForCi;
 exports.getOrAskForProjectData = getOrAskForProjectData;
 exports.createNewConfigFile = createNewConfigFile;
 const childProcess = __importStar(require("node:child_process"));
@@ -63,7 +64,6 @@ const ui_1 = require("../ui");
 const oauth_1 = require("./oauth");
 const api_1 = require("../lib/api");
 const ampli_settings_1 = require("./ampli-settings");
-const constants_2 = require("../lib/constants");
 const urls_1 = require("./urls");
 const semver_1 = require("./semver");
 const wizard_abort_1 = require("./wizard-abort");
@@ -151,11 +151,11 @@ async function installPackage({ packageName, alreadyInstalled, packageNameDispla
         }
         catch (e) {
             sdkInstallSpinner.stop('Installation failed.');
-            (0, ui_1.getUI)().log.error(`${chalk_1.default.red('Encountered the following error during installation:')}\n\n${e}\n\n${chalk_1.default.dim(`The wizard has created a \`amplitude-wizard-installation-error-*.log\` file. If you think this issue is caused by the Amplitude wizard, create an issue on GitHub and include the log file's content:\n${constants_1.ISSUES_URL}`)}`);
+            (0, ui_1.getUI)().log.error(`${chalk_1.default.red('Encountered the following error during installation:')}\n\n${e}\n\n${chalk_1.default.dim(`The wizard has created a \`amplitude-wizard-installation-error-*.log\` file. If you think this issue is caused by the Amplitude wizard, create an issue on GitHub and include the log file's content:\n${constants_1.OUTBOUND_URLS.githubIssues}`)}`);
             await abort();
         }
         sdkInstallSpinner.stop(`${alreadyInstalled ? 'Updated' : 'Installed'} ${chalk_1.default.bold.cyan(packageNameDisplayLabel ?? packageName)} with ${chalk_1.default.bold(pkgManager.label)}.`);
-        analytics_1.analytics.wizardCapture('package installed', {
+        analytics_1.analytics.wizardCapture('Package Installed', {
             package_name: packageName,
             package_manager: pkgManager.name,
             integration,
@@ -237,6 +237,57 @@ function isUsingTypeScript({ installDir, }) {
         return false;
     }
 }
+/**
+ * Best-effort credentials for `--ci` when `--api-key` / AMPLITUDE_WIZARD_API_KEY
+ * is not set: project-local key (.env.local / keychain), then OAuth id token from
+ * ~/.ampli.json plus org/workspace from ampli.json (same resolution as interactive bootstrap).
+ */
+async function tryResolveCredentialsForCi(installDir) {
+    const { readApiKeyWithSource } = await import('./api-key-store.js');
+    const local = readApiKeyWithSource(installDir);
+    if (local) {
+        return {
+            host: constants_1.DEFAULT_HOST_URL,
+            projectApiKey: local.key,
+            accessToken: local.key,
+            cloudRegion: 'us',
+        };
+    }
+    const { getStoredUser, getStoredToken } = await import('./ampli-settings.js');
+    const { readAmpliConfig } = await import('../lib/ampli-config.js');
+    const { getAPIKey } = await import('./get-api-key.js');
+    const { getHostFromRegion } = await import('./urls.js');
+    const storedUser = getStoredUser();
+    const realUser = storedUser && storedUser.id !== 'pending' ? storedUser : null;
+    const projectConfig = readAmpliConfig(installDir);
+    const projectZone = projectConfig.ok ? projectConfig.config.Zone : undefined;
+    const zone = realUser?.zone ?? projectZone ?? constants_1.DEFAULT_AMPLITUDE_ZONE;
+    const storedToken = realUser
+        ? getStoredToken(realUser.id, realUser.zone)
+        : getStoredToken(undefined, zone);
+    if (!storedToken?.idToken) {
+        return null;
+    }
+    const workspaceId = projectConfig.ok
+        ? projectConfig.config.WorkspaceId
+        : undefined;
+    const projectApiKey = await getAPIKey({
+        installDir,
+        idToken: storedToken.idToken,
+        zone,
+        workspaceId,
+    });
+    if (!projectApiKey) {
+        return null;
+    }
+    const cloudRegion = zone === 'eu' ? 'eu' : 'us';
+    return {
+        host: getHostFromRegion(cloudRegion),
+        projectApiKey,
+        accessToken: storedToken.idToken,
+        cloudRegion,
+    };
+}
 /**
  * Get project data for the wizard via Amplitude OAuth or CI API key.
  *
@@ -258,6 +309,32 @@ async function getOrAskForProjectData(_options) {
             cloudRegion: 'us',
         };
     }
+    if (_options.ci) {
+        const ciInstallDir = _options.installDir;
+        if (!ciInstallDir) {
+            (0, ui_1.getUI)().log.error(chalk_1.default.red('CI mode requires --install-dir (or AMPLITUDE_WIZARD_INSTALL_DIR).'));
+            await (0, wizard_abort_1.wizardAbort)({
+                message: 'CI mode requires an install directory.',
+            });
+        }
+        else {
+            const resolved = await tryResolveCredentialsForCi(ciInstallDir);
+            if (resolved) {
+                (0, ui_1.getUI)().log.info(chalk_1.default.dim('Resolved Amplitude API key non-interactively (CI mode).'));
+                return {
+                    host: resolved.host,
+                    projectApiKey: resolved.projectApiKey,
+                    accessToken: resolved.accessToken,
+                    projectId: _options.projectId ?? 0,
+                    cloudRegion: resolved.cloudRegion,
+                };
+            }
+            (0, ui_1.getUI)().log.error(chalk_1.default.red('CI mode could not resolve a project API key. Pass --api-key or AMPLITUDE_WIZARD_API_KEY, store a key in the project (.env.local / keychain), or ensure ~/.ampli.json has a valid OAuth session (and ampli.json includes WorkspaceId if needed).'));
+            await (0, wizard_abort_1.wizardAbort)({
+                message: 'CI mode requires a project API key or resolvable Amplitude credentials.',
+            });
+        }
+    }
     // Force fresh OAuth for projects that haven't been set up yet — no local
     // ampli.json means we don't know which Amplitude org this project belongs to.
     let forceFresh = false;
@@ -280,7 +357,7 @@ async function getOrAskForProjectData(_options) {
 async function askForWizardLogin(opts = {}) {
     // ── 1. Authenticate via Amplitude OAuth (reuses ampli CLI session) ──
     const auth = await (0, oauth_1.performAmplitudeAuth)({
-        zone: constants_2.DEFAULT_AMPLITUDE_ZONE,
+        zone: constants_1.DEFAULT_AMPLITUDE_ZONE,
         forceFresh: opts.forceFresh,
     });
     // ── 2. Detect actual cloud region (EU users auth via US endpoint but

package/dist/src/utils/shell-completions.d.ts

@@ -1,7 +1,7 @@
 type SupportedShell = 'zsh' | 'bash';
 export declare function detectShell(): SupportedShell | null;
-export declare const ZSH_COMPLETION_SCRIPT = "###-begin-amplitude-wizard-completions-###\n\n_amplitude_wizard() {\n  local state\n  local -a commands global_opts wizard_opts\n\n  commands=(\n    'login:Log in to your Amplitude account'\n    'logout:Log out of your Amplitude account'\n    'whoami:Show the currently logged-in Amplitude account'\n    'slack:Set up Amplitude Slack integration'\n    'mcp:MCP server management commands'\n    'completion:Print shell completion script'\n  )\n\n  global_opts=(\n    '--debug[Enable verbose logging]'\n    '--verbose[Print diagnostic info to the run log]'\n    '--signup[Create a new Amplitude account during setup]'\n    '--ci[Enable non-interactive CI mode]'\n    '--api-key[Amplitude project API key]:key:'\n    '--project-id[Amplitude project ID]:id:'\n    '--local-mcp[Use local MCP server at http://localhost:8787/mcp]'\n    {-h,--help}'[Show help]'\n    {-v,--version}'[Show version]'\n  )\n\n  wizard_opts=(\n    '--force-install[Force package install even if peer checks fail]'\n    '--install-dir[Directory to install Amplitude in]:dir:_files -/'\n    '--integration[Framework integration to set up]:integration:(nextjs vue react-router django flask fastapi javascript_web javascript_node python)'\n    '--menu[Show integration selection menu instead of auto-detecting]'\n    '--benchmark[Run in benchmark mode with per-phase token tracking]'\n  )\n\n  _arguments -C \\\n    '1: :->cmd' \\\n    '*:: :->args'\n\n  case $state in\n    cmd)\n      _describe 'command' commands\n      _arguments $global_opts $wizard_opts\n      ;;\n    args)\n      case ${words[1]} in\n        mcp)\n          local -a mcp_cmds\n          mcp_cmds=('add:Install Amplitude MCP server' 'remove:Remove Amplitude MCP server')\n          _arguments -C '1: :->sub' '*:: :->subargs'\n          case $state in\n            sub) _describe 'mcp command' mcp_cmds ;;\n            subargs) _arguments '--local[Use local MCP server at http://localhost:8787]' ;;\n          esac\n          ;;\n        login)\n          _arguments '--zone[Amplitude data center zone]:zone:(us eu)'\n          ;;\n        *)\n          _arguments $global_opts $wizard_opts\n          ;;\n      esac\n      ;;\n  esac\n}\n\n(( $+functions[compdef] )) || { autoload -Uz compinit; compinit; }\ncompdef _amplitude_wizard amplitude-wizard\n###-end-amplitude-wizard-completions-###";
-export declare const BASH_COMPLETION_SCRIPT = "###-begin-amplitude-wizard-completions-###\n_amplitude_wizard_completions() {\n  local cur prev\n  cur=\"${COMP_WORDS[COMP_CWORD]}\"\n  prev=\"${COMP_WORDS[COMP_CWORD-1]}\"\n\n  local commands=\"login logout whoami slack mcp completion\"\n  local global_flags=\"--debug --verbose --signup --ci --api-key --project-id --local-mcp --help --version\"\n  local wizard_flags=\"--force-install --install-dir --integration --menu --benchmark\"\n  local integrations=\"nextjs vue react-router django flask fastapi javascript_web javascript_node python\"\n\n  if [[ ${COMP_CWORD} -eq 1 ]]; then\n    COMPREPLY=($(compgen -W \"$commands $global_flags $wizard_flags\" -- \"$cur\"))\n    return\n  fi\n\n  case \"${COMP_WORDS[1]}\" in\n    mcp)\n      if [[ ${COMP_CWORD} -eq 2 ]]; then\n        COMPREPLY=($(compgen -W \"add remove\" -- \"$cur\"))\n      else\n        COMPREPLY=($(compgen -W \"--local\" -- \"$cur\"))\n      fi\n      ;;\n    login)\n      if [[ \"$prev\" == \"--zone\" ]]; then\n        COMPREPLY=($(compgen -W \"us eu\" -- \"$cur\"))\n      else\n        COMPREPLY=($(compgen -W \"--zone\" -- \"$cur\"))\n      fi\n      ;;\n    *)\n      if [[ \"$prev\" == \"--integration\" ]]; then\n        COMPREPLY=($(compgen -W \"$integrations\" -- \"$cur\"))\n      elif [[ \"$prev\" == \"--install-dir\" ]]; then\n        COMPREPLY=($(compgen -d -- \"$cur\"))\n      else\n        COMPREPLY=($(compgen -W \"$global_flags $wizard_flags\" -- \"$cur\"))\n      fi\n      ;;\n  esac\n}\ncomplete -F _amplitude_wizard_completions amplitude-wizard\n###-end-amplitude-wizard-completions-###";
+export declare const ZSH_COMPLETION_SCRIPT = "###-begin-amplitude-wizard-completions-###\n\n_amplitude_wizard() {\n  local state\n  local -a commands global_opts wizard_opts\n\n  commands=(\n    'login:Log in to your Amplitude account'\n    'logout:Log out of your Amplitude account'\n    'whoami:Show the currently logged-in Amplitude account'\n    'feedback:Send product feedback'\n    'slack:Set up Amplitude Slack integration'\n    'mcp:MCP server management commands'\n    'completion:Print shell completion script'\n  )\n\n  global_opts=(\n    '--debug[Enable verbose logging]'\n    '--verbose[Print diagnostic info to the run log]'\n    '--signup[Create a new Amplitude account during setup]'\n    '--ci[Enable non-interactive CI mode]'\n    '--api-key[Amplitude project API key]:key:'\n    '--project-id[Amplitude project ID]:id:'\n    '--local-mcp[Use local MCP server at http://localhost:8787/mcp]'\n    {-h,--help}'[Show help]'\n    {-v,--version}'[Show version]'\n  )\n\n  wizard_opts=(\n    '--force-install[Force package install even if peer checks fail]'\n    '--install-dir[Directory to install Amplitude in]:dir:_files -/'\n    '--integration[Framework integration to set up]:integration:(nextjs vue react-router django flask fastapi javascript_web javascript_node python)'\n    '--menu[Show integration selection menu instead of auto-detecting]'\n    '--benchmark[Run in benchmark mode with per-phase token tracking]'\n  )\n\n  _arguments -C \\\n    '1: :->cmd' \\\n    '*:: :->args'\n\n  case $state in\n    cmd)\n      _describe 'command' commands\n      _arguments $global_opts $wizard_opts\n      ;;\n    args)\n      case ${words[1]} in\n        mcp)\n          local -a mcp_cmds\n          mcp_cmds=('add:Install Amplitude MCP server' 'remove:Remove Amplitude MCP server')\n          _arguments -C '1: :->sub' '*:: :->subargs'\n          case $state in\n            sub) _describe 'mcp command' mcp_cmds ;;\n            subargs) _arguments '--local[Use local MCP server at http://localhost:8787]' ;;\n          esac\n          ;;\n        login)\n          _arguments '--zone[Amplitude data center zone]:zone:(us eu)'\n          ;;\n        feedback)\n          _arguments '--message[Feedback message]:message:' '-m[Feedback message]:message:'\n          ;;\n        *)\n          _arguments $global_opts $wizard_opts\n          ;;\n      esac\n      ;;\n  esac\n}\n\n(( $+functions[compdef] )) || { autoload -Uz compinit; compinit; }\ncompdef _amplitude_wizard amplitude-wizard\n###-end-amplitude-wizard-completions-###";
+export declare const BASH_COMPLETION_SCRIPT = "###-begin-amplitude-wizard-completions-###\n_amplitude_wizard_completions() {\n  local cur prev\n  cur=\"${COMP_WORDS[COMP_CWORD]}\"\n  prev=\"${COMP_WORDS[COMP_CWORD-1]}\"\n\n  local commands=\"login logout whoami feedback slack mcp completion\"\n  local global_flags=\"--debug --verbose --signup --ci --api-key --project-id --local-mcp --help --version\"\n  local wizard_flags=\"--force-install --install-dir --integration --menu --benchmark\"\n  local integrations=\"nextjs vue react-router django flask fastapi javascript_web javascript_node python\"\n\n  if [[ ${COMP_CWORD} -eq 1 ]]; then\n    COMPREPLY=($(compgen -W \"$commands $global_flags $wizard_flags\" -- \"$cur\"))\n    return\n  fi\n\n  case \"${COMP_WORDS[1]}\" in\n    mcp)\n      if [[ ${COMP_CWORD} -eq 2 ]]; then\n        COMPREPLY=($(compgen -W \"add remove\" -- \"$cur\"))\n      else\n        COMPREPLY=($(compgen -W \"--local\" -- \"$cur\"))\n      fi\n      ;;\n    login)\n      if [[ \"$prev\" == \"--zone\" ]]; then\n        COMPREPLY=($(compgen -W \"us eu\" -- \"$cur\"))\n      else\n        COMPREPLY=($(compgen -W \"--zone\" -- \"$cur\"))\n      fi\n      ;;\n    feedback)\n      COMPREPLY=($(compgen -W \"--message -m\" -- \"$cur\"))\n      ;;\n    *)\n      if [[ \"$prev\" == \"--integration\" ]]; then\n        COMPREPLY=($(compgen -W \"$integrations\" -- \"$cur\"))\n      elif [[ \"$prev\" == \"--install-dir\" ]]; then\n        COMPREPLY=($(compgen -d -- \"$cur\"))\n      else\n        COMPREPLY=($(compgen -W \"$global_flags $wizard_flags\" -- \"$cur\"))\n      fi\n      ;;\n  esac\n}\ncomplete -F _amplitude_wizard_completions amplitude-wizard\n###-end-amplitude-wizard-completions-###";
 /**
  * Silently appends `eval "$(amplitude-wizard completion)"` to the user's shell
  * RC file if it isn't already there.  Call fire-and-forget at startup.

package/dist/src/utils/shell-completions.js

@@ -72,6 +72,7 @@ _amplitude_wizard() {
     'login:Log in to your Amplitude account'
     'logout:Log out of your Amplitude account'
     'whoami:Show the currently logged-in Amplitude account'
+    'feedback:Send product feedback'
     'slack:Set up Amplitude Slack integration'
     'mcp:MCP server management commands'
     'completion:Print shell completion script'
@@ -120,6 +121,9 @@ _amplitude_wizard() {
         login)
           _arguments '--zone[Amplitude data center zone]:zone:(us eu)'
           ;;
+        feedback)
+          _arguments '--message[Feedback message]:message:' '-m[Feedback message]:message:'
+          ;;
         *)
           _arguments $global_opts $wizard_opts
           ;;
@@ -137,7 +141,7 @@ _amplitude_wizard_completions() {
   cur="${DB}COMP_WORDS[COMP_CWORD]}"
   prev="${DB}COMP_WORDS[COMP_CWORD-1]}"
 
-  local commands="login logout whoami slack mcp completion"
+  local commands="login logout whoami feedback slack mcp completion"
   local global_flags="--debug --verbose --signup --ci --api-key --project-id --local-mcp --help --version"
   local wizard_flags="--force-install --install-dir --integration --menu --benchmark"
   local integrations="nextjs vue react-router django flask fastapi javascript_web javascript_node python"
@@ -162,6 +166,9 @@ _amplitude_wizard_completions() {
         COMPREPLY=($(compgen -W "--zone" -- "$cur"))
       fi
       ;;
+    feedback)
+      COMPREPLY=($(compgen -W "--message -m" -- "$cur"))
+      ;;
     *)
       if [[ "$prev" == "--integration" ]]; then
         COMPREPLY=($(compgen -W "$integrations" -- "$cur"))

package/dist/src/utils/track-wizard-feedback.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Send a single feedback event to Amplitude via the Node SDK.
+ * Uses the same API key and server URL as other wizard telemetry.
+ */
+export declare function trackWizardFeedback(message: string): Promise<void>;

package/dist/src/utils/track-wizard-feedback.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.trackWizardFeedback = trackWizardFeedback;
+const analytics_node_1 = require("@amplitude/analytics-node");
+const uuid_1 = require("uuid");
+const analytics_js_1 = require("./analytics.js");
+/**
+ * Send a single feedback event to Amplitude via the Node SDK.
+ * Uses the same API key and server URL as other wizard telemetry.
+ */
+async function trackWizardFeedback(message) {
+    const trimmed = message.trim();
+    if (!trimmed) {
+        throw new Error('Feedback message cannot be empty');
+    }
+    const apiKey = (0, analytics_js_1.resolveTelemetryApiKey)();
+    if (!apiKey) {
+        throw new Error('Feedback cannot be sent: set AMPLITUDE_API_KEY or unset it to use the default telemetry project.');
+    }
+    const client = (0, analytics_node_1.createInstance)();
+    await client.init(apiKey, { serverUrl: (0, analytics_js_1.getAmplitudeNodeServerUrl)() }).promise;
+    const deviceId = (0, uuid_1.v4)();
+    client.track(analytics_js_1.WIZARD_FEEDBACK_EVENT_TYPE, { message: trimmed }, { device_id: deviceId });
+    await client.flush().promise;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amplitude/wizard",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.1",
   "homepage": "https://github.com/amplitude/wizard",
   "repository": "https://github.com/amplitude/wizard",
   "description": "The Amplitude wizard helps you to configure your project",
@@ -37,6 +37,7 @@
   },
   "dependencies": {
     "@amplitude/analytics-browser": "^2.0.0",
+    "@amplitude/analytics-node": "^1.5.51",
     "@anthropic-ai/claude-agent-sdk": "0.2.7",
     "@inkjs/ui": "^2.0.0",
     "@inquirer/prompts": "^8.3.0",