# @platformappnet/cli

> Command Line Interface for platformapp.net

Latest version **0.1.2** (published 2020-10-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @platformappnet/cli
pnpm add @platformappnet/cli
yarn add @platformappnet/cli
bun add @platformappnet/cli
```

Provides the command `platformapp`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2020-10-21 |
| First published | 2020-10-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10 |
| Dependencies | 9 |
| Unpacked size | 15.6 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| Author | Platform |
| Maintainers | platformjb |
| Keywords | platformapp, jamstack, content, cms |

## Links

- npm: https://www.npmjs.com/package/@platformappnet/cli
- Repository: https://github.com/platformapp/platform-cli
- Issues: https://github.com/platformapp/platform-cli/issues
- npm.io page: https://npm.io/package/@platformappnet/cli

## Dependencies (9)

- [joi](https://npm.io/package/joi.md) ^17.2.1
- [ora](https://npm.io/package/ora.md) ^5.1.0
- [axios](https://npm.io/package/axios.md) ^0.20.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [ramda](https://npm.io/package/ramda.md) ^0.27.1
- [yargs](https://npm.io/package/yargs.md) ^16.0.3
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.14.0
- [log-symbols](https://npm.io/package/log-symbols.md) ^4.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2020-10-21

## README

# 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
```

---
_Source: https://npm.io/package/@platformappnet/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._