# @amplitude/ampli > Amplitude CLI Latest version **1.36.6** (published 2026-07-10) · UNLICENSED license · 0 weekly downloads ## Install ```sh npm install @amplitude/ampli pnpm add @amplitude/ampli yarn add @amplitude/ampli bun add @amplitude/ampli ``` Provides the command `ampli`. ## Health **Score 55/100 (C)** — status: active. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. ## Facts | | | |---|---| | Version | 1.36.6 | | Published | 2026-07-10 | | First published | 2021-10-01 | | Weekly downloads | 0 | | License | UNLICENSED | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=12.0.0 | | Dependencies | 51 | | Unpacked size | 5.2 MB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | Author | Amplitude, Inc. | | Maintainers | curtisbliu, kelson.warner, sdk.dev, eric_amplitude, daniel-graham-amplitude, jjwang123 | | Keywords | ampli, amplitude, cli, data, governance, codegen | ## Links - npm: https://www.npmjs.com/package/@amplitude/ampli - Homepage: https://amplitude.com - npm.io page: https://npm.io/package/@amplitude/ampli ## Dependencies (51) - [ora](https://npm.io/package/ora.md) ^4.1.1 - [tmp](https://npm.io/package/tmp.md) ^0.2.4 - [conf](https://npm.io/package/conf.md) ^6.2.0 - [open](https://npm.io/package/open.md) ^7.3.1 - [uuid](https://npm.io/package/uuid.md) ^9.0.0 - [chalk](https://npm.io/package/chalk.md) ^2.4.2 - [debug](https://npm.io/package/debug.md) ^4.1.1 - [json5](https://npm.io/package/json5.md) ^2.1.1 - [tslib](https://npm.io/package/tslib.md) ^1.14.1 - [dotenv](https://npm.io/package/dotenv.md) ^8.2.0 - [globby](https://npm.io/package/globby.md) ^10.0.1 - [lodash](https://npm.io/package/lodash.md) ^4.17.23 - [rimraf](https://npm.io/package/rimraf.md) ^3.0.2 - [graphql](https://npm.io/package/graphql.md) ^15.4.0 - [antlr4ts](https://npm.io/package/antlr4ts.md) ^0.5.0-alpha.4 - [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0 - [get-port](https://npm.io/package/get-port.md) ^5.0.0 - [inquirer](https://npm.io/package/inquirer.md) 8.2.6 - [minimatch](https://npm.io/package/minimatch.md) ^3.1.4 - [stoppable](https://npm.io/package/stoppable.md) ^1.1.0 - [ansi-regex](https://npm.io/package/ansi-regex.md) ^5.0.1 - [node-fetch](https://npm.io/package/node-fetch.md) ^2.7.0 - [php-parser](https://npm.io/package/php-parser.md) ^3.0.0-prerelease.8 - [typescript](https://npm.io/package/typescript.md) ^3.9.7 - [vue-parser](https://npm.io/package/vue-parser.md) ^1.1.6 - [graphql-tag](https://npm.io/package/graphql-tag.md) ^2.11.0 - [ignore-walk](https://npm.io/package/ignore-walk.md) ^3.0.3 - [@sentry/node](https://npm.io/package/@sentry/node.md) ^6.2.5 - [@types/debug](https://npm.io/package/@types/debug.md) ^4.1.5 - [randomstring](https://npm.io/package/randomstring.md) ^1.1.5 - [@babel/parser](https://npm.io/package/@babel/parser.md) ^7.12.11 - [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.15.1 - [@oclif/errors](https://npm.io/package/@oclif/errors.md) ^1.2.2 - [@oclif/parser](https://npm.io/package/@oclif/parser.md) ^3.8.3 - [@sentry/types](https://npm.io/package/@sentry/types.md) ^6.2.5 - [client-oauth2](https://npm.io/package/client-oauth2.md) ^4.3.3 - [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.6.1 - [pkce-challenge](https://npm.io/package/pkce-challenge.md) ^2.2.0 - [@amplitude/node](https://npm.io/package/@amplitude/node.md) ^1.10.0 - [@babel/traverse](https://npm.io/package/@babel/traverse.md) ^7.29.0 - [@types/inquirer](https://npm.io/package/@types/inquirer.md) ^8.2.4 - [graphql-request](https://npm.io/package/graphql-request.md) ^3.3.0 - [@amplitude/types](https://npm.io/package/@amplitude/types.md) ^1.10.0 - [https-proxy-agent](https://npm.io/package/https-proxy-agent.md) ^5.0.1 - [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^3.2.2 - [@amplitude/identify](https://npm.io/package/@amplitude/identify.md) ^1.10.0 - [@oclif/plugin-update](https://npm.io/package/@oclif/plugin-update.md) ^1.3.10 - [@phenomnomnominal/tsquery](https://npm.io/package/@phenomnomnominal/tsquery.md) ^3.0.0 - [@oclif/plugin-autocomplete](https://npm.io/package/@oclif/plugin-autocomplete.md) ^0.3.0 - [inquirer-autocomplete-prompt](https://npm.io/package/inquirer-autocomplete-prompt.md) ^2.0.0 - [@oclif/plugin-warn-if-update-available](https://npm.io/package/@oclif/plugin-warn-if-update-available.md) ^1.7.0 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 1.36.6 (latest) — 2026-07-10 - 1.36.5 — 2026-07-09 - 1.36.4 — 2026-07-08 - 1.36.3 — 2026-04-08 - 1.36.2 — 2025-02-20 - 1.36.1 — 2025-02-20 - 1.36.0 — 2025-02-20 - 1.35.0 — 2024-03-13 - 1.34.0 — 2023-10-11 - 1.33.0 — 2023-09-06 - 1.32.0 — 2023-07-20 - 1.31.5 — 2023-04-21 - 1.31.4 — 2023-03-24 - 1.31.3 — 2023-03-24 - 1.31.2 — 2023-03-15 - … 51 more at https://npm.io/package/@amplitude/ampli/versions ## README ampli ==== Amplitude CLI [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![Version](https://img.shields.io/npm/v/@amplitude/ampli.svg)](https://www.npmjs.com/package/@amplitude/ampli) [![Downloads/week](https://img.shields.io/npm/dw/@amplitude/ampli.svg)](https://npmjs.org/package/@amplitude/ampli) [![License](https://img.shields.io/npm/l/@amplitude/ampli.svg)](https://npmjs.org/package/@amplitude/ampli) * [Requirements](#requirements) * [Usage](#usage) * [Commands](#commands) # Requirements Amplitude CLI requires Node 12+ # Usage ```sh-session $ npm install -g @amplitude/ampli $ ampli COMMAND running command... $ ampli (-v|--version|version) @amplitude/ampli/1.36.6 linux-x64 node-v24.18.0 $ ampli --help [COMMAND] USAGE $ ampli COMMAND ... ``` # Commands * [`ampli autocomplete [SHELL]`](#ampli-autocomplete-shell) * [`ampli branch`](#ampli-branch) * [`ampli checkout []`](#ampli-checkout-branch) * [`ampli configure [--deprecated-runtimes]`](#ampli-configure---deprecated-runtimes) * [`ampli help [COMMAND]`](#ampli-help-command) * [`ampli init`](#ampli-init) * [`ampli login`](#ampli-login) * [`ampli logout`](#ampli-logout) * [`ampli pull [] [-p ] [-b ]`](#ampli-pull-source--p-path--b-branch) * [`ampli refresh`](#ampli-refresh) * [`ampli setup`](#ampli-setup) * [`ampli source`](#ampli-source) * [`ampli status`](#ampli-status) * [`ampli whoami`](#ampli-whoami) ## `ampli autocomplete [SHELL]` display autocomplete installation instructions ``` USAGE $ ampli autocomplete [SHELL] ARGUMENTS SHELL shell type OPTIONS -r, --refresh-cache Refresh cache (ignores displaying instructions) EXAMPLES $ ampli autocomplete $ ampli autocomplete bash $ ampli autocomplete zsh $ ampli autocomplete --refresh-cache ``` _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_ ## `ampli branch` list all branches ``` USAGE $ ampli branch OPTIONS -t, --token=token personal API token to authenticate with ``` ## `ampli checkout []` checkout a branch for the current source ``` USAGE $ ampli checkout [] OPTIONS -t, --token=token personal API token to authenticate with -v, --version=version the version to checkout EXAMPLES $ ampli checkout develop $ ampli checkout ``` ## `ampli configure [--deprecated-runtimes]` Configure and update source runtime ``` USAGE $ ampli configure [--deprecated-runtimes] OPTIONS -t, --token=token personal API token to authenticate with --deprecated-runtimes show deprecated SDK options for source configuration (for Itly users). EXAMPLES $ ampli configure $ ampli configure --deprecated-runtimes ``` ## `ampli help [COMMAND]` display help for ampli ``` USAGE $ ampli help [COMMAND] ARGUMENTS COMMAND command to show help for OPTIONS --all see all commands in CLI ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.3.1/src/commands/help.ts)_ ## `ampli init` initialize your workspace ``` USAGE $ ampli init OPTIONS -o, --org=org organization -w, --workspace=workspace workspace -z, --zone=us|eu regional zone --user=user user email EXAMPLES $ ampli init [--org ORGANIZATION] [--workspace WORKSPACE] $ ampli init [--user username@some.domain] ``` ## `ampli login` log into Amplitude ``` USAGE $ ampli login OPTIONS -z, --zone=us|eu regional zone EXAMPLE $ ampli login ``` ## `ampli logout` log out from Amplitude ``` USAGE $ ampli logout OPTIONS -z, --zone=us|eu regional zone --user=user user email EXAMPLES $ ampli logout $ ampli logout --user username@some.domain ``` ## `ampli pull [] [-p ] [-b ]` pull down the latest tracking plan and generate a tracking library ``` USAGE $ ampli pull [] [-p ] [-b ] OPTIONS -b, --branch=branch the branch to pull -p, --path=path where the tracking library will be created -t, --token=token personal API token to authenticate with -v, --version=version the version to pull --deprecated-runtimes show deprecated SDK options for source configuration (for Itly users). --include-api-keys include api keys to the tracking library --omit-api-keys omit api keys from the tracking library EXAMPLES $ ampli pull web $ ampli pull web -p ./ampli -b develop $ ampli pull web -p ./ampli -b develop -v 2.1.1 $ ampli pull --omit-api-keys web $ ampli pull --include-api-keys web $ ampli pull --deprecated-runtimes ``` ## `ampli refresh` refresh current branch with any changes that may have been made to main branch ``` USAGE $ ampli refresh OPTIONS -t, --token=token personal API token to authenticate with EXAMPLE $ ampli refresh ``` ## `ampli setup` show setup instructions for the current source ``` USAGE $ ampli setup OPTIONS -t, --token=token personal API token to authenticate with EXAMPLE $ ampli setup ``` ## `ampli source` list all sources ``` USAGE $ ampli source OPTIONS -t, --token=token personal API token to authenticate with ``` ## `ampli status` verify (lint) your source code for analytics ``` USAGE $ ampli status OPTIONS -b, --branch=branch enforces source is on provided the branch -t, --token=token personal API token to authenticate with -u, --update update tracking plan with latest implementation status --instanceNames=instanceNames Ampli instance name(s) to check --is-latest check if current version is the latest --is-latest-if-not-default-branch check if current version is the latest (do not check if on default branch) --is-merged check if current branch/version has been merged into default branch --skip-update-on-default-branch prevents updating implementation status on default branch --sourceDirs=sourceDirs source code location EXAMPLES $ ampli status $ ampli status -u $ ampli status -b main $ ampli status -u --skip-update-on-default-branch $ ampli status --sourceDirs ./src ./util $ ampli status --is-merged $ ampli status --is-latest $ ampli status --is-latest-if-not-default-branch $ ampli status --instanceNames myAmpliInstanceName ampli itly foo ``` ## `ampli whoami` display user information ``` USAGE $ ampli whoami OPTIONS -z, --zone=us|eu regional zone ``` --- _Source: https://npm.io/package/@amplitude/ampli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._