+++
title = "Harvest CLI"
description = "Руководство по использованию harvest-CLI"
keywords = ["harvest", "cli", "harvest-cli", "command line interface"]
weight = 400
+++
# Harvest CLI

Harvest CLI — это небольшой исполняемый файл, который поставляется вместе с сервером Harvest. Его можно выполнить на том же компьютере, на котором работает сервер Harvest. Harvest CLI имеет команды «plugins» и «admin», а также глобальные параметры.

Чтобы перечислить все команды и параметры:
```
графана-кли -h
```
## Вызов интерфейса командной строки Harvest

Чтобы вызвать Harvest CLI, добавьте путь к двоичным файлам Harvest в переменную среды PATH. В качестве альтернативы, если ваш текущий каталог является каталогом `bin`, используйте `./harvest-cli`. В противном случае вы можете указать полный путь к CLI. Например, в Linux `/usr/share/harvest/bin/harvest-cli`, а в Windows `C:\Program Files\HarvestLabs\harvest\bin\harvest-cli.exe`.

>**Примечание.** Для некоторых команд, таких как установка или удаление плагинов, в Linux требуется `sudo`. Если вы используете Windows, запустите Windows PowerShell от имени администратора.

## Синтаксис команды Harvest CLI

Общий синтаксис команд в Harvest CLI:
``` ударить
harvest-cli [глобальные параметры] команда [параметры команды] [аргументы...]
```

## Глобальные параметры

Интерфейс командной строки Harvest позволяет временно переопределять определенные настройки Harvest по умолчанию. За исключением `--help` и `--version`, большинство глобальных параметров используются только разработчиками.

Каждая глобальная опция применяется только к той команде, в которой она используется. Например, значение `--pluginsDir` не меняется навсегда, где Harvest сохраняет плагины. Он изменяет его только для команды, в которой вы применяете параметр.

### Показать справку Harvest CLI

`--help` или `-h` отображает справку, включая пути по умолчанию и информацию о конфигурации Docker.

**Пример:**
``` ударить
графана-кли -h
```

### Показать версию Harvest CLI

`--version` или `-v` выводит текущую версию Harvest CLI.

**Пример:**
``` ударить
графана-кли -v
```

### Переопределить каталог плагинов по умолчанию

`--pluginsDir value` переопределяет путь, по которому ваш локальный экземпляр Harvest хранит плагины. Используйте эту опцию, если вы хотите установить, обновить или удалить плагин не в каталоге по умолчанию ("/var/lib/harvest/plugins") [$GF_PLUGIN_DIR].

**Пример:**
``` ударить
harvest-cli --pluginsDir "/var/lib/harvest/devplugins" plugins install <plugin-id>
```

### Переопределить URL репозитория плагинов по умолчанию

`--repo value` позволяет загружать и устанавливать или обновлять плагины из репозитория, отличного от репозитория Harvest по умолчанию.

**Пример:**
``` ударить
harvest-cli --repo "https://example.com/plugins" plugins install <plugin-id>
```

### Переопределить URL-адрес .zip плагина по умолчанию

`--pluginUrl value` позволяет вам загрузить файл .zip, содержащий плагин, с локального URL-адреса вместо загрузки его из источника Harvest по умолчанию.

**Пример:**
``` ударить
harvest-cli --pluginUrl https://company.com/harvest/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>
```

### Переопределить безопасность транспортного уровня

**Предупреждение.** Отключение TLS представляет серьезную угрозу безопасности. Мы не рекомендуем использовать эту опцию.

`--insecure` позволяет отключить проверку безопасности транспортного уровня (TLS) (небезопасно). Вы можете сделать это, если загружаете плагин из источника, отличного от используемого по умолчанию.

**Пример:**
``` ударить
harvest-cli --insecure --pluginUrl https://company.com/harvest/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>
```

### Включить ведение журнала отладки

`--debug` или `-d` включает ведение журнала отладки. Вывод отладки возвращается и отображается в терминале.

**Пример:**
``` ударить
harvest-cli --debug plugins install <plugin-id>
```

### Переопределить настройку конфигурации

`--configOverrides` — это аргумент командной строки, который действует как переопределение переменной окружения.

Например, вы можете использовать его для перенаправления ведения журнала в другой файл (возможно, для регистрации установки плагинов в Harvest Cloud) или при сбросе пароля администратора, если у вас есть значения по умолчанию для некоторых важных значений конфигурации (например, где находится база данных).

**Пример:**
``` ударить
harvest-cli --configOverrides cfg:default.paths.log=/dev/null plugins install <plugin-id>
```

### Переопределить значение домашнего пути

Устанавливает путь для установки/домашнего пути Harvest, по умолчанию рабочий каталог. Вам не нужно использовать это, если вы находитесь в каталоге установки Harvest при использовании CLI.

**Пример:**
``` ударить
harvest-cli --homepath "/usr/share/harvest" admin reset-admin-password <новый пароль>
```

### Переопределить файл конфигурации

`--config value` переопределяет расположение по умолчанию, где Harvest ожидает файл конфигурации. См. [Конфигурация]({{< relref "../administration/configuration.md" >}}) для получения дополнительной информации о настройке Harvest и расположении файлов конфигурации по умолчанию.

**Пример:**
``` ударить
harvest-cli --config "/etc/configuration/" admin reset-admin-password mynewpassword
```

## Команды плагинов

Harvest CLI позволяет устанавливать, обновлять и управлять плагинами Harvest. Дополнительные сведения об установке подключаемых модулей см. на [странице подключаемых модулей]({{< relref "../plugins/installation.md" >}}).

Все перечисленные команды применяются к репозиториям и каталогам Harvest по умолчанию. Вы можете переопределить значения по умолчанию с помощью [Глобальные параметры](#global-options).
```
