The command line interface for PostHog 🦔
npm install @posthog/cli``bash
> posthog-cli --help
The command line interface for PostHog 🦔
Usage: posthog-cli [OPTIONS]
Commands:
login Interactively authenticate with PostHog, storing a personal API token locally. You can also use the environment variables POSTHOG_CLI_TOKEN, POSTHOG_CLI_ENV_ID and POSTHOG_CLI_HOST
query Run a SQL query against any data you have in posthog. This is mostly for fun, and subject to change
sourcemap Upload a directory of bundled chunks to PostHog
exp Contains a set of experimental commands
help Print this message or the help of the given subcommand(s)
Options:
--host
-h, --help Print help
-V, --version Print version
`
You can authenticate with PostHog interactively for using the CLI locally, but if you'd like to use it in a CI/CD pipeline, we recommend using these environment variables:
- POSTHOG_CLI_HOST: The PostHog host to connect to [default: https://us.posthog.com]POSTHOG_CLI_TOKEN
- : A posthog personal API key.POSTHOG_CLI_ENV_ID
- : The ID number of the project/environment to connect to. E.g. the "2" in https://us.posthog.com/project/2
Commands require different API scopes. Make sure to set these scopes on your personal API key:
| Command | Required Scopes |
| ----------------------------- | ------------------------------------------ |
| query | query:read |sourcemap
| | error_tracking:write |exp endpoints list/get/pull
| | endpoint:read |exp endpoints push
| | endpoint:write, insight_variable:write |exp endpoints run
| | query:read |exp tasks
| | task:read` |