npm promulgates marsupials

    @amplitude/ampli
    TypeScript icon, indicating that this package has built-in type declarations

    1.27.1 • Public • Published

    ampli

    Amplitude CLI

    oclif Version Downloads/week License

    Requirements

    Amplitude CLI requires Node 12+

    Usage

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

    Commands

    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
    
    EXAMPLES
      $ ampli checkout develop
      $ ampli checkout
    

    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
      -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 [<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
      --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 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
      --instanceName=instanceName        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
      --sourceDir=sourceDir              source code location
    
    EXAMPLES
      $ ampli status
      $ ampli status -u
      $ ampli status -b main
      $ ampli status -u --skip-update-on-default-branch
      $ ampli status --sourceDir ./src ./util
      $ ampli status --is-merged
      $ ampli status --is-latest
      $ ampli status --is-latest-if-not-default-branch
      $ ampli status --instanceName myAmpliInstanceName ampli itly foo
    

    ampli whoami

    display user information

    USAGE
      $ ampli whoami
    
    OPTIONS
      -z, --zone=us|eu  regional zone
    

    Install

    npm i @amplitude/ampli

    DownloadsWeekly Downloads

    4,140

    Version

    1.27.1

    License

    UNLICENSED

    Unpacked Size

    5.23 MB

    Total Files

    362

    Last publish

    Collaborators

    • mae.capozzi
    • sdk.dev
    • dnshi
    • kevinpagtakhan
    • justin-fiedler
    • qingzhuo
    • rctbusk
    • manthursday
    • jackmccloy
    • amp_haoliu
    • myztiq
    • curtisbliu
    • jtran
    • kelvin-lu
    • nutwani
    • hao.yu
    • kelson.warner
    • ajhorst_amp
    • brian.giori