@amplitude/ampli/oclif.manifest.json

Amplitude CLI

{"version":"1.36.2","commands":{"branch":{"id":"branch","description":"list all branches","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"personal API token to authenticate with"},"withOrg":{"name":"withOrg","type":"option","description":"admin access to organization","hidden":true},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","hidden":true,"options":["us","eu"],"default":""}},"args":[]},"checkout":{"id":"checkout","description":"checkout a branch for the current source","usage":"checkout [<branch>]","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"examples":["$ ampli checkout develop","$ ampli checkout"],"flags":{"version":{"name":"version","type":"option","char":"v","description":"the version to checkout"},"token":{"name":"token","type":"option","char":"t","description":"personal API token to authenticate with"},"withOrg":{"name":"withOrg","type":"option","description":"admin access to organization","hidden":true},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","hidden":true,"options":["us","eu"],"default":""}},"args":[{"name":"branch","required":false}]},"configure":{"id":"configure","description":"Configure and update source runtime","usage":"configure [--deprecated-runtimes]","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"examples":["$ ampli configure","$ ampli configure --deprecated-runtimes"],"flags":{"deprecated-runtimes":{"name":"deprecated-runtimes","type":"boolean","description":"show deprecated SDK options for source configuration (for Itly users).","allowNo":false},"token":{"name":"token","type":"option","char":"t","description":"personal API token to authenticate with"},"withOrg":{"name":"withOrg","type":"option","description":"admin access to organization","hidden":true},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","hidden":true,"options":["us","eu"],"default":""}},"args":[]},"info":{"id":"info","description":"display information about the ampli environment","pluginName":"@amplitude/ampli","pluginType":"core","hidden":true,"aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"personal API token to authenticate with"},"withOrg":{"name":"withOrg","type":"option","description":"admin access to organization","hidden":true},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","hidden":true,"options":["us","eu"],"default":""}},"args":[]},"init":{"id":"init","description":"initialize your workspace","usage":"init","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"examples":["$ ampli init [--org ORGANIZATION] [--workspace WORKSPACE]","$ ampli init [--user username@some.domain]"],"flags":{"org":{"name":"org","type":"option","char":"o","description":"organization"},"workspace":{"name":"workspace","type":"option","char":"w","description":"workspace"},"user":{"name":"user","type":"option","description":"user email"},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","options":["us","eu"],"default":""}},"args":[]},"login":{"id":"login","description":"log into Amplitude","usage":"login","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"examples":["$ ampli login"],"flags":{"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","options":["us","eu"],"default":""}},"args":[]},"logout":{"id":"logout","description":"log out from Amplitude","usage":"logout","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"examples":["$ ampli logout","$ ampli logout --user username@some.domain"],"flags":{"user":{"name":"user","type":"option","description":"user email"},"all":{"name":"all","type":"boolean","char":"a","description":"logout all users","hidden":true,"allowNo":false},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","options":["us","eu"],"default":""}},"args":[]},"pull":{"id":"pull","description":"pull down the latest tracking plan and generate a tracking library","usage":"pull [<source>] [-p <path>] [-b <branch>]","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"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"],"flags":{"branch":{"name":"branch","type":"option","char":"b","description":"the branch to pull"},"version":{"name":"version","type":"option","char":"v","description":"the version to pull"},"path":{"name":"path","type":"option","char":"p","description":"where the tracking library will be created"},"omit-api-keys":{"name":"omit-api-keys","type":"boolean","description":"omit api keys from the tracking library","allowNo":false},"include-api-keys":{"name":"include-api-keys","type":"boolean","description":"include api keys to the tracking library","allowNo":false},"deprecated-runtimes":{"name":"deprecated-runtimes","type":"boolean","description":"show deprecated SDK options for source configuration (for Itly users).","allowNo":false},"token":{"name":"token","type":"option","char":"t","description":"personal API token to authenticate with"},"withOrg":{"name":"withOrg","type":"option","description":"admin access to organization","hidden":true},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","hidden":true,"options":["us","eu"],"default":""}},"args":[{"name":"source","required":false}]},"refresh":{"id":"refresh","description":"refresh current branch with any changes that may have been made to main branch","usage":"refresh","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"examples":["$ ampli refresh"],"flags":{"token":{"name":"token","type":"option","char":"t","description":"personal API token to authenticate with"},"withOrg":{"name":"withOrg","type":"option","description":"admin access to organization","hidden":true},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","hidden":true,"options":["us","eu"],"default":""}},"args":[]},"setup":{"id":"setup","description":"show setup instructions for the current source","usage":"setup","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"examples":["$ ampli setup"],"flags":{"token":{"name":"token","type":"option","char":"t","description":"personal API token to authenticate with"},"withOrg":{"name":"withOrg","type":"option","description":"admin access to organization","hidden":true},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","hidden":true,"options":["us","eu"],"default":""}},"args":[]},"source":{"id":"source","description":"list all sources","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"personal API token to authenticate with"},"withOrg":{"name":"withOrg","type":"option","description":"admin access to organization","hidden":true},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","hidden":true,"options":["us","eu"],"default":""}},"args":[]},"status":{"id":"status","description":"verify (lint) your source code for analytics","usage":"status","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"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"],"flags":{"update":{"name":"update","type":"boolean","char":"u","description":"update tracking plan with latest implementation status","allowNo":false},"branch":{"name":"branch","type":"option","char":"b","description":"enforces source is on provided the branch"},"skip-update-on-default-branch":{"name":"skip-update-on-default-branch","type":"boolean","description":"prevents updating implementation status on default branch","allowNo":false},"runtime":{"name":"runtime","type":"option","description":"(developer) override source runtime id","hidden":true},"sourceDirs":{"name":"sourceDirs","type":"option","description":"source code location"},"sourceDir":{"name":"sourceDir","type":"option","description":"source code location","hidden":true},"is-merged":{"name":"is-merged","type":"boolean","description":"check if current branch/version has been merged into default branch","allowNo":false},"is-latest":{"name":"is-latest","type":"boolean","description":"check if current version is the latest","allowNo":false},"is-latest-if-not-default-branch":{"name":"is-latest-if-not-default-branch","type":"boolean","description":"check if current version is the latest (do not check if on default branch)","allowNo":false},"instanceNames":{"name":"instanceNames","type":"option","description":"Ampli instance name(s) to check"},"instanceName":{"name":"instanceName","type":"option","description":"Ampli instance name(s) to check","hidden":true},"token":{"name":"token","type":"option","char":"t","description":"personal API token to authenticate with"},"withOrg":{"name":"withOrg","type":"option","description":"admin access to organization","hidden":true},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","hidden":true,"options":["us","eu"],"default":""}},"args":[]},"verify":{"id":"verify","description":"verify (lint) your source code for analytics","usage":"verify","pluginName":"@amplitude/ampli","pluginType":"core","hidden":true,"aliases":[],"examples":["$ ampli verify","$ ampli verify -u","$ ampli verify -b main","$ ampli verify -u --skip-update-on-default-branch"],"flags":{"update":{"name":"update","type":"boolean","char":"u","description":"update tracking plan with latest implementation status","allowNo":false},"branch":{"name":"branch","type":"option","char":"b","description":"enforces source is on provided the branch"},"skip-update-on-default-branch":{"name":"skip-update-on-default-branch","type":"boolean","description":"prevents updating implementation status on default branch","allowNo":false},"runtime":{"name":"runtime","type":"option","description":"(developer) override source runtime id","hidden":true},"token":{"name":"token","type":"option","char":"t","description":"personal API token to authenticate with"},"withOrg":{"name":"withOrg","type":"option","description":"admin access to organization","hidden":true},"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","hidden":true,"options":["us","eu"],"default":""}},"args":[]},"whoami":{"id":"whoami","description":"display user information","pluginName":"@amplitude/ampli","pluginType":"core","aliases":[],"flags":{"debug":{"name":"debug","type":"boolean","description":"(developer) enable debug logging to file","hidden":true,"allowNo":false},"showProgress":{"name":"showProgress","type":"boolean","description":"(developer) show progress","hidden":true,"allowNo":true},"userDir":{"name":"userDir","type":"option","description":"user directory","hidden":true,"default":""},"projectDir":{"name":"projectDir","type":"option","description":"project directory","hidden":true,"default":"."},"renameConfigs":{"name":"renameConfigs","type":"boolean","description":"rename/converts configs to ampli.json","hidden":true,"allowNo":true},"zone":{"name":"zone","type":"option","char":"z","description":"regional zone","options":["us","eu"],"default":""}},"args":[]}}}