Docs: Update references of grafana-cli to grafana cli and grafana-server to grafana server. (#66981)

* Update grafana-cli to grafana cli in relevant docs/sources

* Update relevant docs to use 'grafana server' instead of 'grafana-server'
This commit is contained in:
Kevin Minehart
2023-04-26 13:18:03 -05:00
committed by GitHub
parent d7bd06a87e
commit 3fc796dfe6
11 changed files with 44 additions and 44 deletions

View File

@@ -1,11 +1,11 @@
---
aliases:
- administration/cli/
description: Guide to using grafana-cli
description: Guide to using grafana cli
keywords:
- grafana
- cli
- grafana-cli
- grafana cli
- command line interface
title: Grafana CLI
weight: 400
@@ -18,12 +18,12 @@ Grafana CLI is a small executable that is bundled with Grafana server. It can be
To list all commands and options:
```
grafana-cli -h
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-cli` and on Windows `C:\Program Files\GrafanaLabs\grafana\bin\grafana-cli.exe`.
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`.
> **Note:** Some commands, such as installing or removing plugins, require `sudo` on Linux. If you are on Windows, run Windows PowerShell as Administrator.
@@ -32,7 +32,7 @@ To invoke Grafana CLI, add the path to the grafana binaries in your `PATH` envir
The general syntax for commands in Grafana CLI is:
```bash
grafana-cli [global options] command [command options] [arguments...]
grafana cli [global options] command [command options] [arguments...]
```
## Global options
@@ -48,7 +48,7 @@ Each global option applies only to the command in which it is used. For example,
**Example:**
```bash
grafana-cli -h
grafana cli -h
```
### Display Grafana CLI version
@@ -58,7 +58,7 @@ grafana-cli -h
**Example:**
```bash
grafana-cli -v
grafana cli -v
```
### Override default plugin directory
@@ -68,7 +68,7 @@ grafana-cli -v
**Example:**
```bash
grafana-cli --pluginsDir "/var/lib/grafana/devplugins" plugins install <plugin-id>
grafana cli --pluginsDir "/var/lib/grafana/devplugins" plugins install <plugin-id>
```
### Override default plugin repo URL
@@ -78,7 +78,7 @@ grafana-cli --pluginsDir "/var/lib/grafana/devplugins" plugins install <plugin-i
**Example:**
```bash
grafana-cli --repo "https://example.com/plugins" plugins install <plugin-id>
grafana cli --repo "https://example.com/plugins" plugins install <plugin-id>
```
### Override default plugin .zip URL
@@ -88,7 +88,7 @@ grafana-cli --repo "https://example.com/plugins" plugins install <plugin-id>
**Example:**
```bash
grafana-cli --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>
grafana cli --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>
```
### Override Transport Layer Security
@@ -100,7 +100,7 @@ grafana-cli --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-
**Example:**
```bash
grafana-cli --insecure --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>
grafana cli --insecure --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>
```
### Enable debug logging
@@ -110,7 +110,7 @@ grafana-cli --insecure --pluginUrl https://company.com/grafana/plugins/<plugin-i
**Example:**
```bash
grafana-cli --debug plugins install <plugin-id>
grafana cli --debug plugins install <plugin-id>
```
### Override a configuration setting
@@ -122,7 +122,7 @@ For example, you can use it to redirect logging to another file (maybe to log pl
**Example:**
```bash
grafana-cli --configOverrides cfg:default.paths.log=/dev/null plugins install <plugin-id>
grafana cli --configOverrides cfg:default.paths.log=/dev/null plugins install <plugin-id>
```
### Override homepath value
@@ -132,7 +132,7 @@ Sets the path for the Grafana install/home path, defaults to working directory.
**Example:**
```bash
grafana-cli --homepath "/usr/share/grafana" admin reset-admin-password <new password>
grafana cli --homepath "/usr/share/grafana" admin reset-admin-password <new password>
```
### Override config file
@@ -142,7 +142,7 @@ grafana-cli --homepath "/usr/share/grafana" admin reset-admin-password <new pass
**Example:**
```bash
grafana-cli --config "/etc/configuration/" admin reset-admin-password mynewpassword
grafana cli --config "/etc/configuration/" admin reset-admin-password mynewpassword
```
## Plugins commands
@@ -154,43 +154,43 @@ All listed commands apply to the Grafana default repositories and directories. Y
### List available plugins
```bash
grafana-cli plugins list-remote
grafana cli plugins list-remote
```
### Install the latest version of a plugin
```bash
grafana-cli plugins install <plugin-id>
grafana cli plugins install <plugin-id>
```
### Install a specific version of a plugin
```bash
grafana-cli plugins install <plugin-id> <version>
grafana cli plugins install <plugin-id> <version>
```
### List installed plugins
```bash
grafana-cli plugins ls
grafana cli plugins ls
```
### Update all installed plugins
```bash
grafana-cli plugins update-all
grafana cli plugins update-all
```
### Update one plugin
```bash
grafana-cli plugins update <plugin-id>
grafana cli plugins update <plugin-id>
```
### Remove one plugin
```bash
grafana-cli plugins remove <plugin-id>
grafana cli plugins remove <plugin-id>
```
## Admin commands
@@ -200,12 +200,12 @@ Admin commands are only available in Grafana 4.1 and later.
### Show all admin commands
```bash
grafana-cli admin
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.
`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:
@@ -214,7 +214,7 @@ If there are two flags being used to set the homepath and the config file path,
To correct this, use the `--homepath` global option to specify the Grafana default homepath for this command:
```bash
grafana-cli --homepath "/usr/share/grafana" admin reset-admin-password <new password>
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.
@@ -230,5 +230,5 @@ If you need to set the password in a script, then you can use the [Grafana User
**Example:**
```bash
grafana-cli admin data-migration encrypt-datasource-passwords
grafana cli admin data-migration encrypt-datasource-passwords
```