---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://ytsaurus.tech/docs/en/user-guide/data-processing/chyt/cli-and-api.md
  - https://ytsaurus.tech/docs/ru/user-guide/data-processing/chyt/cli-and-api.md
---
> **Documentation Index:** Fetch the complete configuration index at https://ytsaurus.tech/docs/ru/llms.txt

<!-- source: ru/_includes/user-guide/data-processing/chyt/cli-and-api-intro.md -->
# CLI и Python API

Чтобы запустить свою клику или отправить запрос в CHYT из программы либо из командной строки, можно воспользоваться CHYT CLI и CHYT Python API. Они могут быть получены в составе пакета `ytsaurus-client`.

Утилита командной строки воспринимает две переменные окружения: `YT_PROXY` и `CHYT_ALIAS`. С помощью первой из них можно указать кластер YTsaurus, а с помощью второй &mdash; используемую клику.

Например, под Linux и macOS можно использовать следующую команду, чтобы установить переменные окружения и больше не передавать параметры `--proxy <cluster_name>` и `--alias ch_public` во все последующие вызовы:

```bash
export YT_PROXY=<cluster_name> CHYT_ALIAS=ch_public
```
{% note info "Примечание" %}

Для совместимости со старыми версиями алиас клики можно указывать со звёздочкой в начале, в таком случае она игнорируется.

{% endnote %}

Запускающий клику процесс иногда может неформально называться *лончером*.

## ytsaurus-client { #ytsaurus-client }

Основной способ начать работать с YTsaurus — установить пакет `ytsaurus-client`. Подробнее об этом можно прочитать в статье [Python Wrapper](https://ytsaurus.tech/docs/ru/api/python/start.md).
<!-- endsource: ru/_includes/user-guide/data-processing/chyt/cli-and-api-intro.md -->

<!-- source: ru/_includes/user-guide/data-processing/chyt/cli-and-api-details.md -->
В составе распространяется программа `yt`. Для того чтобы воспользоваться функциональностью CHYT, можно запустить любую команду как `yt clickhouse [command]`.

Например, следующим образом можно сделать тестовый запрос в публичную клику `ch_public`:

```bash
yt clickhouse execute "select 'Hello world'" --alias ch_public
```

Помимо этого пакет содержит Python API для работы с CHYT, доступный в модуле `yt.clickhouse`:

```bash
python3
Python 3.7.3 (default, Oct  7 2019, 12:56:13)
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import yt.clickhouse as chyt
>>> import yt.wrapper as yt
>>> client = yt.YtClient("<cluster_name>")
>>> list(chyt.execute("select * from `//home/user/sample_table`", alias="ch_public", client=client))
[{'a': 100}, {'a': 101}, {'a': 102}, {'a': 205}, {'a': 206}, {'a': 1100}]
```

Библиотека доступна для Python 3.

Детальную спецификацию возможностей Python API и CLI вы можете найти в статье [Выполнение запросов](https://ytsaurus.tech/docs/ru/user-guide/data-processing/chyt/reference/execute.md).
<!-- endsource: ru/_includes/user-guide/data-processing/chyt/cli-and-api-details.md -->