a3d688c8ed
* Provide the list of admins if the admin with the default ID was not found * Clean up * Update docs * Update docs/sources/cli.md Co-authored-by: Dan Cech <dcech@grafana.com> * Update pkg/cmd/grafana-cli/commands/reset_password_command.go Co-authored-by: Dan Cech <dcech@grafana.com> * Lint --------- Co-authored-by: Dan Cech <dcech@grafana.com>
8.0 KiB
| aliases | description | keywords | labels | title | weight | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Guide to using grafana cli |
|
|
Grafana CLI | 400 |
Grafana CLI
Grafana CLI is a small executable that is bundled with Grafana server. It can be executed on the same machine Grafana server is running on. Grafana CLI has plugins and admin commands, as well as global options.
To list all commands and options:
grafana cli -h
Invoking Grafana CLI
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 and on Windows C:\Program Files\GrafanaLabs\grafana\bin\grafana.exe, and invoke it with grafana cli.
{{% admonition type="note" %}}
Some commands, such as installing or removing plugins, require sudo on Linux. If you are on Windows, run Windows PowerShell as Administrator.
{{% /admonition %}}
Grafana CLI command syntax
The general syntax for commands in Grafana CLI is:
grafana cli [global options] command [command options] [arguments...]
Global options
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.
Display Grafana CLI help
--help or -h displays the help, including default paths and Docker configuration information.
Example:
grafana cli -h
Display Grafana CLI version
--version or -v prints the version of Grafana CLI currently running.
Example:
grafana cli -v
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:
grafana cli --pluginsDir "/var/lib/grafana/devplugins" plugins install <plugin-id>
Override default plugin repo URL
--repo value allows you to download and install or update plugins from a repository other than the default Grafana repo.
Example:
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:
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:
grafana cli --insecure --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>
Enable debug logging
--debug or -d enables debug logging. Debug output is returned and shown in the terminal.
Example:
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:
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.
Example:
grafana cli --homepath "/usr/share/grafana" admin reset-admin-password <new password>
Override config file
--config value overrides the default location where Grafana expects the configuration file. Refer to [Configuration]({{< relref "./setup-grafana/configure-grafana/" >}}) for more information about configuring Grafana and default configuration file locations.
Example:
grafana cli --config "/etc/configuration/" admin reset-admin-password mynewpassword
Plugins commands
Grafana CLI allows you to install, upgrade, and manage your Grafana plugins. For more information about installing plugins, refer to [plugins page]({{< relref "./administration/plugin-management/" >}}).
All listed commands apply to the Grafana default repositories and directories. You can override the defaults with Global Options.
List available plugins
grafana cli plugins list-remote
Install the latest version of a plugin
grafana cli plugins install <plugin-id>
Install a specific version of a plugin
grafana cli plugins install <plugin-id> <version>
List installed plugins
grafana cli plugins ls
Update all installed plugins
grafana cli plugins update-all
Update one plugin
grafana cli plugins update <plugin-id>
Remove one plugin
grafana cli plugins remove <plugin-id>
Admin commands
Admin commands are only available in Grafana 4.1 and later.
Show all admin commands
grafana cli admin
Reset admin password
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. By default, this command uses the default ID of the admin user, which is 1. If you know the ID of the admin user, you can use the --user-id flag to specify the user ID. If the --user-id flag is not specified and the command cannot find the admin user, it returns the list of current admin users' username and ID. From that list you can determine the ID of the admin user and run the command again with the --user-id flag.
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:
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 [Grafana User API]({{< relref "./developers/http_api/user/#change-password" >}}).
Reset admin password
If you installed Grafana using Homebrew, you can reset the admin password using the following command:
/opt/homebrew/opt/grafana/bin/grafana cli --config /opt/homebrew/etc/grafana/grafana.ini --homepath /opt/homebrew/opt/grafana/share/grafana --configOverrides cfg:default.paths.data=/opt/homebrew/var/lib/grafana admin reset-admin-password <new password>
Migrate data and encrypt passwords
data-migration runs a script that migrates or cleans up data in your database.
encrypt-datasource-passwords migrates passwords from unsecured fields to secure_json_data field. Returns ok unless there is an error. Safe to execute multiple times.
Example:
grafana cli admin data-migration encrypt-datasource-passwords