DOS CLI Tools for Visual Studio Code

The DOS CLI Tools extension for Visual Studio Code provides an enhanced experience developing data pipeline metadata using Health Catalyst's Data Operating System (DOS).

It is a companion tool to the DOS CLI, a command-line interface tool for accelerating and scaling data pipeline development through the generation of YAML metadata files.

Getting started

The DOS CLI Tools extension is designed to be used in conjunction with the DOS CLI. In order to get started, make sure you have the necessary prerequisites and install the DOS CLI.

Prerequisites

In order to install the DOS CLI, .NET Core 3.1 SDK is required. Once you have .NET installed, or if you have it already, you may proceed to install the DOS CLI.

While the DOS CLI and this extension may be used without the Data Operating System (DOS), its functionality will be significantly limited. Several CLI commands will not be able to work without authenticating with a DOS install. If you are interested in learning more about Health Catalyst and DOS, you may request more information from our website.

DOS CLI install

To install the CLI, open up a terminal and run the following command:

dotnet tool install --global DOS.CLI

Version must be specified as part of installs while the CLI remains in a pre-release state (e.g., dotnet tool install --global DOS.CLI --version 0.0.22033-build02). Available versions may be found on the CLI's nuget page.

For more information on the DOS CLI and its commands, see its product documentation or use the command help directly in the terminal by typing a command and then one of the help commands (-?, -h, --help).

 dos --help

Features

Metadata validation & suggestions

The YAML files generated by the DOS CLI can be complex to navigate. The DOS CLI Tools extension provides syntax highlighting, suggestions, and validation to ensure your metadata is valid and may be published to a Data Operating System (DOS) environment successfully.

Metadata model snippets

Snippets allow for quick creation of metadata models within the YAML files. This is particularly useful when trying to create additional components not generated automatically as part of the file creation (e.g., fields, incremental configurations, attributes, field groups, etc.). Eliminates need to memorize or lookup properties while developing.

Tabbing through the generated snippet allows for quickly setting required values.

Property descriptions on hover

Hovering over properties provide additional information in regards to their purpose and format. If additional information is desired beyond what is provided in the tooltips, see the product documentation.