Installing the YDB DSTool

To install the YDB DSTool, follow these steps:

1. Run the command:

   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.

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

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

   ydb-dstool -e <bs_endpoint> cluster list
   

   • bs_endpoint: URI of the cluster's HTTP endpoint, the same endpoint that serves the Embedded UI. Example: http://localhost:8765.

   Result:

   ┌───────┬───────┬───────┬────────┬────────┬───────┬────────┐
   │ Hosts │ Nodes │ Pools │ Groups │ VDisks │ Boxes │ PDisks │
   ├───────┼───────┼───────┼────────┼────────┼───────┼────────┤
   │ 8     │ 16    │ 1     │ 5      │ 40     │ 1     │ 32     │
   └───────┴───────┴───────┴────────┴────────┴───────┴────────┘
   

To install the YDB DSTool, follow these steps:

1. Run the command:

   • in PowerShell:

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

   • in CMD:

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

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

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

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

   Note

   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:

   chcp 65001
   

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

   ydb-dstool -e <bs_endpoint> cluster list
   

   • bs_endpoint: URI of the cluster's HTTP endpoint, the same endpoint that serves the Embedded UI. Example: http://localhost:8765.

   Result:

   ┌───────┬───────┬───────┬────────┬────────┬───────┬────────┐
   │ Hosts │ Nodes │ Pools │ Groups │ VDisks │ Boxes │ PDisks │
   ├───────┼───────┼───────┼────────┼────────┼───────┼────────┤
   │ 8     │ 16    │ 1     │ 5      │ 40     │ 1     │ 32     │
   └───────┴───────┴───────┴────────┴────────┴───────┴────────┘