---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://ydb.tech/docs/en/reference/ydb-dstool/install.md
  - https://ydb.tech/docs/ru/reference/ydb-dstool/install.md
sourcePath: en/core/reference/ydb-dstool/install.md
---
> **Documentation Index:** Fetch the complete configuration index at https://ydb.tech/docs/en/llms.txt

# Installing the YDB DSTool

<!-- markdownlint-disable blanks-around-fences -->

{% list tabs %}

- Linux

    <!-- source: en/reference/ydb-dstool/_includes/unix_install.md -->
    To install the YDB DSTool, follow these steps:

    1. Run the command:

        <!-- source: en/reference/ydb-dstool/_includes/unix_install_command.md -->
        <!-- markdownlint-disable blanks-around-fences -->

        ```bash
        curl -sSL 'https://install.ydb.tech/dstool' | bash
        ```

        The script will install the YDB DSTool. If the script is run from a `bash` or `zsh` shell, it will also add the `ydb-dstool` executable to the `PATH` environment variable. Otherwise, you can run it from the `~/ydb/bin` folder or add it to `PATH` manually.
        <!-- endsource: en/reference/ydb-dstool/_includes/unix_install_command.md -->

    1. To update the environment variables, restart the command shell.

    1. Test it by running the command that shows cluster information:

        <!-- source: en/reference/ydb-dstool/_includes/test.md -->
        <!-- markdownlint-disable blanks-around-fences -->

        ```bash
        ydb-dstool -e <bs_endpoint> cluster list
        ```

        * `bs_endpoint`: URI of the cluster's HTTP endpoint, the same endpoint that serves the [Embedded UI](https://ydb.tech/docs/en/reference/embedded-ui/index.md). Example: `http://localhost:8765`.

        Result:

        ```text
        ┌───────┬───────┬───────┬────────┬────────┬───────┬────────┐
        │ Hosts │ Nodes │ Pools │ Groups │ VDisks │ Boxes │ PDisks │
        ├───────┼───────┼───────┼────────┼────────┼───────┼────────┤
        │ 8     │ 16    │ 1     │ 5      │ 40     │ 1     │ 32     │
        └───────┴───────┴───────┴────────┴────────┴───────┴────────┘
        ```
        <!-- endsource: en/reference/ydb-dstool/_includes/test.md -->
    <!-- endsource: en/reference/ydb-dstool/_includes/unix_install.md -->

- macOS

    <!-- source: en/reference/ydb-dstool/_includes/unix_install.md -->
    To install the YDB DSTool, follow these steps:

    1. Run the command:

        <!-- source: en/reference/ydb-dstool/_includes/unix_install_command.md -->
        <!-- markdownlint-disable blanks-around-fences -->

        ```bash
        curl -sSL 'https://install.ydb.tech/dstool' | bash
        ```

        The script will install the YDB DSTool. If the script is run from a `bash` or `zsh` shell, it will also add the `ydb-dstool` executable to the `PATH` environment variable. Otherwise, you can run it from the `~/ydb/bin` folder or add it to `PATH` manually.
        <!-- endsource: en/reference/ydb-dstool/_includes/unix_install_command.md -->

    1. To update the environment variables, restart the command shell.

    1. Test it by running the command that shows cluster information:

        <!-- source: en/reference/ydb-dstool/_includes/test.md -->
        <!-- markdownlint-disable blanks-around-fences -->

        ```bash
        ydb-dstool -e <bs_endpoint> cluster list
        ```

        * `bs_endpoint`: URI of the cluster's HTTP endpoint, the same endpoint that serves the [Embedded UI](https://ydb.tech/docs/en/reference/embedded-ui/index.md). Example: `http://localhost:8765`.

        Result:

        ```text
        ┌───────┬───────┬───────┬────────┬────────┬───────┬────────┐
        │ Hosts │ Nodes │ Pools │ Groups │ VDisks │ Boxes │ PDisks │
        ├───────┼───────┼───────┼────────┼────────┼───────┼────────┤
        │ 8     │ 16    │ 1     │ 5      │ 40     │ 1     │ 32     │
        └───────┴───────┴───────┴────────┴────────┴───────┴────────┘
        ```
        <!-- endsource: en/reference/ydb-dstool/_includes/test.md -->
    <!-- endsource: en/reference/ydb-dstool/_includes/unix_install.md -->

- Windows

    To install the YDB DSTool, follow these steps:

    1. Run the command:

        - in **PowerShell**:

            ```powershell
            iex (New-Object System.Net.WebClient).DownloadString('https://install.ydb.tech/dstool-windows')
            ```

        - in **CMD**:

            ```cmd
            @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://install.ydb.tech/dstool-windows'))"
            ```

    1. Specify whether to add `ydb-dstool` to the `PATH` environment variable:

        ```text
        Add ydb-dstool installation dir to your PATH? [Y/n]
        ```

    1. To update the environment variables, restart the command shell.

        {% note info %}

        The YDB DSTool uses Unicode characters in the output of some commands. If these characters aren't displayed correctly in the Windows console, switch the encoding to UTF-8:

        ```cmd
        chcp 65001
        ```

        {% endnote %}

    1. Test it by running the command that shows cluster information:

        <!-- source: en/reference/ydb-dstool/_includes/test.md -->
        <!-- markdownlint-disable blanks-around-fences -->

        ```bash
        ydb-dstool -e <bs_endpoint> cluster list
        ```

        * `bs_endpoint`: URI of the cluster's HTTP endpoint, the same endpoint that serves the [Embedded UI](https://ydb.tech/docs/en/reference/embedded-ui/index.md). Example: `http://localhost:8765`.

        Result:

        ```text
        ┌───────┬───────┬───────┬────────┬────────┬───────┬────────┐
        │ Hosts │ Nodes │ Pools │ Groups │ VDisks │ Boxes │ PDisks │
        ├───────┼───────┼───────┼────────┼────────┼───────┼────────┤
        │ 8     │ 16    │ 1     │ 5      │ 40     │ 1     │ 32     │
        └───────┴───────┴───────┴────────┴────────┴───────┴────────┘
        ```
        <!-- endsource: en/reference/ydb-dstool/_includes/test.md -->

{% endlist %}