@amplitude/ampli

ampli

Amplitude CLI

• Requirements
• Usage
• Commands

Requirements

Amplitude CLI requires Node 12+

Usage

$ npm install -g @amplitude/ampli
$ ampli COMMAND
running command...
$ ampli (-v|--version|version)
@amplitude/ampli/0.1.1 linux-x64 node-v12.22.6
$ ampli --help [COMMAND]
USAGE
  $ ampli COMMAND
...

Commands

• ampli autocomplete [SHELL]
• ampli branch
• ampli checkout [<branch>]
• ampli help [COMMAND]
• ampli init
• ampli login
• ampli logout
• ampli pull [<source>] [-p <path>] [-b <branch>]
• ampli source
• ampli status
• 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

ampli branch

list all branches

USAGE
  $ ampli branch

OPTIONS
  -t, --token=token  personal API token to authenticate with

ampli checkout [<branch>]

checkout a branch for the current source

USAGE
  $ ampli checkout [<branch>]

OPTIONS
  -t, --token=token      personal API token to authenticate with
  -v, --version=version  the version to checkout

EXAMPLE
  $ ampli checkout develop

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

ampli init

initialize your workspace

USAGE
  $ ampli init

OPTIONS
  -o, --org=org              organization
  -w, --workspace=workspace  workspace
  --user=user                user email

EXAMPLES
  $ ampli init [--org ORGANIZATION] [--workspace WORKSPACE]
  $ ampli init [--user [e-mail]]

ampli login

log into Amplitude

USAGE
  $ ampli login

EXAMPLE
  $ ampli login

ampli logout

log out from Amplitude

USAGE
  $ ampli logout

OPTIONS
  --user=user  user email

EXAMPLE
  $ ampli logout [--user [e-mail]]

ampli pull [<source>] [-p <path>] [-b <branch>]

pull down the latest tracking plan and generate a tracking library

USAGE
  $ ampli pull [<source>] [-p <path>] [-b <branch>]

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

EXAMPLES
  $ ampli pull web
  $ ampli pull web -p ./ampli -b develop
  $ ampli pull web -p ./ampli -b develop -v 2.1.1

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
  --skip-update-on-default-branch  prevents updating implementation status on default branch

EXAMPLES
  $ ampli status
  $ ampli status -u
  $ ampli status -b main
  $ ampli status -u --skip-update-on-default-branch

ampli whoami

display user information

USAGE
  $ ampli whoami