sml-cli/README.md

Semantic Modeling Language CLI

# sml-cli

Semantic Modeling Language CLI

[![Version](https://img.shields.io/npm/v/sml-cli.svg)](https://npmjs.org/package/sml-cli)
[![Downloads/week](https://img.shields.io/npm/dw/sml-cli.svg)](https://npmjs.org/package/sml-cli)

<!-- toc -->
* [sml-cli](#sml-cli)
* [Usage](#usage)
* [Commands](#commands)
* [License](#license)
<!-- tocstop -->

# Usage

```sh-session
$ npm install -g sml-cli
$ sml-cli COMMAND

running command...
$ sml-cli --version
0.0.0

$ sml-cli --help [COMMAND]
USAGE
  $ sml-cli COMMAND
...
```

# Commands

<!-- commands -->
* [`sml-cli atscale-deploy [FILEPATH]`](#sml-cli-atscale-deploy-filepath)
* [`sml-cli help [COMMAND]`](#sml-cli-help-command)
* [`sml-cli install [FILEPATH]`](#sml-cli-install-filepath)
* [`sml-cli validate [FILEPATH]`](#sml-cli-validate-filepath)

## `sml-cli atscale-deploy [FILEPATH]`

Deploy an SML project to AtScale.

```
USAGE
  $ sml-cli atscale-deploy [FILEPATH] [--catalog-name <value>] [--catalog-label <value>] [--tableau-servers <value>]

ARGUMENTS
  FILEPATH  [default: .] Path to the root of the SML project.

FLAGS
  --catalog-label=<value>    Override catalog label
  --catalog-name=<value>     Override catalog unique name
  --tableau-servers=<value>  JSON string of Tableau server definition names and sites

DESCRIPTION
  Deploy an SML project to AtScale.

  The command requires two environment variables:
  - ATSCALE_API_URL - AtScale API URL
  - ATSCALE_API_TOKEN - AtScale API token

EXAMPLES
  $ sml-cli atscale-deploy

  $ sml-cli atscale-deploy --catalog-name="Name" --catalog-label="Label"

  $ sml-cli atscale-deploy --tableau-servers='[{"name": "server1", "sites": ["site1", "site2"]}, {"name": "server2", "sites": ["site3"]}]'

  $ sml-cli atscale-deploy ./path-to-sml-project

  $ sml-cli atscale-deploy ./path-to-sml-project --catalog-name="Name" --catalog-label="Label"

  $ sml-cli atscale-deploy ./path-to-sml-project --tableau-servers='[{"name": "server1", "sites": ["site1", "site2"]}, {"name": "server2", "sites": ["site3"]}]'
```

## `sml-cli help [COMMAND]`

Display help for sml-cli.

```
USAGE
  $ sml-cli help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for sml-cli.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.25/src/commands/help.ts)_

## `sml-cli install [FILEPATH]`

Install SML package dependencies

```
USAGE
  $ sml-cli install [FILEPATH] [--concurrency <value>]

ARGUMENTS
  FILEPATH  [default: .] Path to the root of the SML project.

FLAGS
  --concurrency=<value>  [default: 2] How many concurrent downloads to perform

DESCRIPTION
  Install SML package dependencies

EXAMPLES
  $ sml-cli install

  $ sml-cli install ./path-to-sml-project

  $ sml-cli install --concurrency=1

  $ sml-cli install ./path-to-sml-project --concurrency=2
```

## `sml-cli validate [FILEPATH]`

Validate an SML project.

```
USAGE
  $ sml-cli validate [FILEPATH]

ARGUMENTS
  FILEPATH  [default: .] Path to the root of the SML project.

DESCRIPTION
  Validate an SML project.

EXAMPLES
  $ sml-cli validate

  $ sml-cli validate ./path-to-sml-project
```
<!-- commandsstop -->

# License

This project is licensed under the [Apache License 2.0](LICENSE). See the LICENSE file for full details.