open-index/open-npm huggingface dataset:
npm package: @platformappnet/cli
Description: Command Line Interface for platformapp.net
Author: Platform
Latest version: 0.1.2

# Platform CLI

The command line interface for [Platform](https://platformapp.net/) projects.

For full documentation, please see [https://docs.platformapp.net/cli](https://docs.platformapp.net/cli).

## Installation

Install globally with NPM:

```
npm install -g @platformappnet/cli
```

...or with Yarn

```
yarn global add @platformappnet/cli
```

Install within the scope of a project:

```
npm install @platformappnet/cli
```

...or with Yarn

```
yarn add @platformappnet/cli
```

## Configuration

The following parameters can be set in a `.env` file, or as environmental variables.

- `PLATFORMAPP_PROJECT_ID` - the Platform project ID, found on your project settings page on the Dashboard.
- `PLATFORMAPP_AUTH_TOKEN` - the Platform API key, configurable in the Developers section of the Dashboard.

All of the above can be passed in using their equivalent CLi arguments (see `platformapp deploy help` for more information).

## Initialising

To create a bare `platformapp.yaml` configuration file, run:

```
platformapp init
```

## Validating

Run the following to validate your `platformapp.yaml` file:

```
platformapp validate
```

## Deploying

Run the following to update blueprints and enums:

```
platformapp deploy
```