Grafana CLI

    To list all commands and options:

    To invoke Grafana CLI, add the path to the grafana binaries in your PATH environment variable. Alternately, if your current directory is the bin directory, use ./grafana-cli. Otherwise, you can specify full path to the CLI. For example, on Linux /usr/share/grafana/bin/grafana-cli and on Windows C:\Program Files\GrafanaLabs\grafana\bin\grafana-cli.exe.

    The general syntax for commands in Grafana CLI is:

    1. grafana-cli [global options] command [command options] [arguments...]

    Grafana CLI allows you to temporarily override certain Grafana default settings. Except for --help and --version, most global options are only used by developers.

    Each global option applies only to the command in which it is used. For example, --pluginsDir value does not permanently change where Grafana saves plugins. It only changes it for command in which you apply the option.

    --help or -h displays the help, including default paths and Docker configuration information.

    Example:

    1. grafana-cli -h

    Display Grafana CLI version

    or -v prints the version of Grafana CLI currently running.

    Example:

      Override default plugin directory

      --pluginsDir value overrides the path to where your local Grafana instance stores plugins. Use this option if you want to install, update, or remove a plugin somewhere other than the default directory (“/var/lib/grafana/plugins”) [$GF_PLUGIN_DIR].

      Example:

      1. grafana-cli --pluginsDir "/var/lib/grafana/devplugins" plugins install <plugin-id>

      Override default plugin repo URL

      Example:

      1. grafana-cli --repo "https://example.com/plugins" plugins install <plugin-id>

      Override default plugin .zip URL

      --pluginUrl value allows you to download a .zip file containing a plugin from a local URL instead of downloading it from the default Grafana source.

      Example:

      1. grafana-cli --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>

      Override Transport Layer Security

      Warning: Turning off TLS is a significant security risk. We do not recommend using this option.

      --insecure allows you to turn off Transport Layer Security (TLS) verification (insecure). You might want to do this if you are downloading a plugin from a non-default source.

      Example:

      --debug or -d enables debug logging. Debug output is returned and shown in the terminal.

      Example:

      1. grafana-cli --debug plugins install <plugin-id>

      Override a configuration setting

      --configOverrides is a command line argument that acts like an environmental variable override.

      For example, you can use it to redirect logging to another file (maybe to log plugin installations in Grafana Cloud) or when resetting the admin password and you have non-default values for some important configuration value (like where the database is located).

      Example:

      1. grafana-cli --configOverrides cfg:default.paths.log=/dev/null plugins install <plugin-id>

      Override homepath value

      Sets the path for the Grafana install/home path, defaults to working directory. You do not need to use this if you are in the Grafana installation directory when using the CLI.

      Override config file

      --config value overrides the default location where Grafana expects the configuration file. Refer to for more information about configuring Grafana and default configuration file locations.

      Example:

      1. grafana-cli --config "/etc/configuration/" admin reset-admin-password mynewpassword

      Grafana CLI allows you to install, upgrade, and manage your Grafana plugins. For more information about installing plugins, refer to .

      All listed commands apply to the Grafana default repositories and directories. You can override the defaults with Global Options.

      List available plugins

      1. grafana-cli plugins list-remote

      Install the latest version of a plugin

      1. grafana-cli plugins install <plugin-id>

      List installed plugins

      1. grafana-cli plugins ls

      Update all installed plugins

      1. grafana-cli plugins update-all

      Update one plugin

      1. grafana-cli plugins update <plugin-id>

      Remove one plugin

      1. grafana-cli plugins remove <plugin-id>

      Admin commands are only available in Grafana 4.1 and later.

      Show all admin commands

        grafana-cli admin reset-admin-password <new password> resets the password for the admin user using the CLI. You might need to do this if you lose the admin password.

        If there are two flags being used to set the homepath and the config file path, then running the command returns this error:

        Could not find config defaults, make sure homepath command line parameter is set or working directory is homepath

        To correct this, use the --homepath global option to specify the Grafana default homepath for this command:

        1. grafana-cli --homepath "/usr/share/grafana" admin reset-admin-password <new password>

        If you have not lost the admin password, we recommend that you change the user password either in the User Preferences or in the Server Admin > User tab.

        If you need to set the password in a script, then you can use the .

        Migrate data and encrypt passwords

        data-migration runs a script that migrates or cleans up data in your database.

        Example: