
I built the [Vendia command-line interface](https://www.npmjs.com/package/@vendia/share-cli).

You can view the [source code here](https://www.npmjs.com/package/@vendia/share-cli/v/0.12.4?activeTab=code).

## About

- Automatic API documentation via source code
- Extendable CLI commands
- Cognito authentication
- Telemetry
- Binary packaging

## API

Interact with [Vendia](https://www.vendia.com/) from the comfort of your CLI.

See the [command line reference](https://www.vendia.com/docs/share/cli) to get started and the docs on using [Vendia](https://www.vendia.com/docs/share/).

## Table of Contents



 AUTO-GENERATED-CONTENT:START (TOC:collapse=true&collapseText=Click to expand) 



- [Install](#install)
- [Top level commands](#top-level-commands)
- [All commands](#all-commands)
  - [share auth](#share-auth)
  - [share client](#share-client)
  - [share file](#share-file)
  - [share login](#share-login)
  - [share logout](#share-logout)
  - [share node](#share-node)
  - [share org](#share-org)
  - [share uni](#share-uni)





## Install

Install the CLI globally

```bash
npm install @vendia/share-cli -g
```

Or install locally without the `-g` global flag

```bash
npm install @vendia/share-cli
```

After installation the `share` binary will be available to use on the machine. 

Run `share --help` to display a list of available commands

```bash
share --help
```

## Top level commands

| Command | description  |
|:--------------------------- |:-----|
| [share auth](#share-auth) | Manage authorization & set current Vendia user  |
| [share client](#share-client) | Manage your local Vendia client  |
| [share file](#share-file) | Manage files in a Uni  |
| [share login](#share-login) | Login to Vendia user account  |
| [share logout](#share-logout) | Logout of Vendia user account  |
| [share node](#share-node) | Manage nodes in a Uni  |
| [share org](#share-org) | Manage your Organization (Enterprise only)  |
| [share uni](#share-uni) | Manage Uni operations  |

---

## All commands

### [share auth](https://docs.vendia.com/share/cli/commands/auth)

Manage authorization & set current Vendia user

| Sub command | description  |
|:--------------------------- |:-----|
| [`auth login`](https://docs.vendia.com/share/cli/commands/auth#auth-login) | Login to Vendia user account  |
| [`auth logout`](https://docs.vendia.com/share/cli/commands/auth#auth-logout) | Logout of Vendia user account  |
| [`auth role`](https://docs.vendia.com/share/cli/commands/auth#auth-role) | Manage roles for users  |
| [`auth role delete`](https://docs.vendia.com/share/cli/commands/auth#auth-role-delete) | Delete roles for users  |
| [`auth role get`](https://docs.vendia.com/share/cli/commands/auth#auth-role-get) | Get role information  |
| [`auth role list`](https://docs.vendia.com/share/cli/commands/auth#auth-role-list) | List roles for user  |
| [`auth role set`](https://docs.vendia.com/share/cli/commands/auth#auth-role-set) | Set Roles for user  |
| [`auth switch`](https://docs.vendia.com/share/cli/commands/auth#auth-switch) | Switch active Vendia account  |
| [`auth whoami`](https://docs.vendia.com/share/cli/commands/auth#auth-whoami) | Display active Vendia account  |


### [share client](https://docs.vendia.com/share/cli/commands/client)

Manage your local Vendia client

| Sub command | description  |
|:--------------------------- |:-----|
| [`client generate`](https://docs.vendia.com/share/cli/commands/client#client-generate) | Generate a custom client for your accessing your Uni's API.  |
| [`client pull`](https://docs.vendia.com/share/cli/commands/client#client-pull) | Writes your Uni's schema files to a local directory - needed in order to generate a custom client for your accessing your Uni's API.  |


### [share file](https://docs.vendia.com/share/cli/commands/file)

Manage files in a Uni

| Sub command | description  |
|:--------------------------- |:-----|
| [`file add`](https://docs.vendia.com/share/cli/commands/file#file-add) | Add a file  |
| [`file get`](https://docs.vendia.com/share/cli/commands/file#file-get) | Get a file  |
| [`file list`](https://docs.vendia.com/share/cli/commands/file#file-list) | List current files  |
| [`file remove`](https://docs.vendia.com/share/cli/commands/file#file-remove) | Remove a file  |
| [`file update`](https://docs.vendia.com/share/cli/commands/file#file-update) | Update a file  |


### [share login](https://docs.vendia.com/share/cli/commands/login)

Login to Vendia user account

### [share logout](https://docs.vendia.com/share/cli/commands/logout)

Logout of Vendia user account

### [share node](https://docs.vendia.com/share/cli/commands/node)

Manage nodes in a Uni

| Sub command | description  |
|:--------------------------- |:-----|
| [`node add-api-key`](https://docs.vendia.com/share/cli/commands/node#node-add-api-key) | Add an API Key  |
| [`node add-jwt-auth`](https://docs.vendia.com/share/cli/commands/node#node-add-jwt-auth) | Add a custom JWT Authentication Provider to a Node  |
| [`node get`](https://docs.vendia.com/share/cli/commands/node#node-get) | Get node configuration  |
| [`node grant-access`](https://docs.vendia.com/share/cli/commands/node#node-grant-access) | Grant user access to a Node  |
| [`node remove-jwt-auth`](https://docs.vendia.com/share/cli/commands/node#node-remove-jwt-auth) | Remove a custom JWT Authentication Provider from a Node  |
| [`node revoke-access`](https://docs.vendia.com/share/cli/commands/node#node-revoke-access) | Revoke a user's access to a Node  |
| [`node schema`](https://docs.vendia.com/share/cli/commands/node#node-schema) | Fetch a Node's GraphQL Schema  |
| [`node sharing-policy`](https://docs.vendia.com/share/cli/commands/node#node-sharing-policy) | Manage sharing policies for a node  |
| [`node update`](https://docs.vendia.com/share/cli/commands/node#node-update) | Update node configuration  |


### [share org](https://docs.vendia.com/share/cli/commands/org)

Manage your Organization (Enterprise only)

| Sub command | description  |
|:--------------------------- |:-----|
| [`org get`](https://docs.vendia.com/share/cli/commands/org#org-get) | Get your Organization (Enterprise only)  |
| [`org list-users`](https://docs.vendia.com/share/cli/commands/org#org-list-users) | List Org Users (Enterprise only)  |


### [share uni](https://docs.vendia.com/share/cli/commands/uni)

Manage Uni operations

| Sub command | description  |
|:--------------------------- |:-----|
| [`uni create`](https://docs.vendia.com/share/cli/commands/uni#uni-create) | Create a new uni  |
| [`uni delete`](https://docs.vendia.com/share/cli/commands/uni#uni-delete) | Permanently delete a uni  |
| [`uni evolve`](https://docs.vendia.com/share/cli/commands/uni#uni-evolve) | Evolve the schema for a Uni  |
| [`uni get`](https://docs.vendia.com/share/cli/commands/uni#uni-get) | Get information about a given uni  |
| [`uni invite`](https://docs.vendia.com/share/cli/commands/uni#uni-invite) | Invite a new node to join the Uni  |
| [`uni join`](https://docs.vendia.com/share/cli/commands/uni#uni-join) | Join an existing Uni  |
| [`uni list`](https://docs.vendia.com/share/cli/commands/uni#uni-list) | Lists all unis in your account  |
| [`uni open`](https://docs.vendia.com/share/cli/commands/uni#uni-open) | Open a Uni in the vendia dev console  |
| [`uni reset`](https://docs.vendia.com/share/cli/commands/uni#uni-reset) | Resets Uni to it's original state  |

I built the [Vendia command-line interface](https://www.npmjs.com/package/@vendia/share-cli).

You can view the [source code here](https://www.npmjs.com/package/@vendia/share-cli/v/0.12.4?activeTab=code).

## About

- Automatic API documentation via source code
- Extendable CLI commands
- Cognito authentication
- Telemetry
- Binary packaging

## API

Interact with [Vendia](https://www.vendia.com/) from the comfort of your CLI.

See the [command line reference](https://www.vendia.com/docs/share/cli) to get started and the docs on using [Vendia](https://www.vendia.com/docs/share/).

## Table of Contents


<details>
<summary>Click to expand</summary>

- [Install](#install)
- [Top level commands](#top-level-commands)
- [All commands](#all-commands)
  - [share auth](#share-auth)
  - [share client](#share-client)
  - [share file](#share-file)
  - [share login](#share-login)
  - [share logout](#share-logout)
  - [share node](#share-node)
  - [share org](#share-org)
  - [share uni](#share-uni)

</details>


## Install

Install the CLI globally

```bash
npm install @vendia/share-cli -g
```

Or install locally without the `-g` global flag

```bash
npm install @vendia/share-cli
```

After installation the `share` binary will be available to use on the machine. 

Run `share --help` to display a list of available commands

```bash
share --help
```

## Top level commands

| Command | description  |
|:--------------------------- |:-----|
| [share auth](#share-auth) | Manage authorization & set current Vendia user  |
| [share client](#share-client) | Manage your local Vendia client  |
| [share file](#share-file) | Manage files in a Uni  |
| [share login](#share-login) | Login to Vendia user account  |
| [share logout](#share-logout) | Logout of Vendia user account  |
| [share node](#share-node) | Manage nodes in a Uni  |
| [share org](#share-org) | Manage your Organization (Enterprise only)  |
| [share uni](#share-uni) | Manage Uni operations  |

---

## All commands

### [share auth](https://docs.vendia.com/share/cli/commands/auth)

Manage authorization & set current Vendia user

| Sub command | description  |
|:--------------------------- |:-----|
| [`auth login`](https://docs.vendia.com/share/cli/commands/auth#auth-login) | Login to Vendia user account  |
| [`auth logout`](https://docs.vendia.com/share/cli/commands/auth#auth-logout) | Logout of Vendia user account  |
| [`auth role`](https://docs.vendia.com/share/cli/commands/auth#auth-role) | Manage roles for users  |
| [`auth role delete`](https://docs.vendia.com/share/cli/commands/auth#auth-role-delete) | Delete roles for users  |
| [`auth role get`](https://docs.vendia.com/share/cli/commands/auth#auth-role-get) | Get role information  |
| [`auth role list`](https://docs.vendia.com/share/cli/commands/auth#auth-role-list) | List roles for user  |
| [`auth role set`](https://docs.vendia.com/share/cli/commands/auth#auth-role-set) | Set Roles for user  |
| [`auth switch`](https://docs.vendia.com/share/cli/commands/auth#auth-switch) | Switch active Vendia account  |
| [`auth whoami`](https://docs.vendia.com/share/cli/commands/auth#auth-whoami) | Display active Vendia account  |


### [share client](https://docs.vendia.com/share/cli/commands/client)

Manage your local Vendia client

| Sub command | description  |
|:--------------------------- |:-----|
| [`client generate`](https://docs.vendia.com/share/cli/commands/client#client-generate) | Generate a custom client for your accessing your Uni's API.  |
| [`client pull`](https://docs.vendia.com/share/cli/commands/client#client-pull) | Writes your Uni's schema files to a local directory - needed in order to generate a custom client for your accessing your Uni's API.  |


### [share file](https://docs.vendia.com/share/cli/commands/file)

Manage files in a Uni

| Sub command | description  |
|:--------------------------- |:-----|
| [`file add`](https://docs.vendia.com/share/cli/commands/file#file-add) | Add a file  |
| [`file get`](https://docs.vendia.com/share/cli/commands/file#file-get) | Get a file  |
| [`file list`](https://docs.vendia.com/share/cli/commands/file#file-list) | List current files  |
| [`file remove`](https://docs.vendia.com/share/cli/commands/file#file-remove) | Remove a file  |
| [`file update`](https://docs.vendia.com/share/cli/commands/file#file-update) | Update a file  |


### [share login](https://docs.vendia.com/share/cli/commands/login)

Login to Vendia user account

### [share logout](https://docs.vendia.com/share/cli/commands/logout)

Logout of Vendia user account

### [share node](https://docs.vendia.com/share/cli/commands/node)

Manage nodes in a Uni

| Sub command | description  |
|:--------------------------- |:-----|
| [`node add-api-key`](https://docs.vendia.com/share/cli/commands/node#node-add-api-key) | Add an API Key  |
| [`node add-jwt-auth`](https://docs.vendia.com/share/cli/commands/node#node-add-jwt-auth) | Add a custom JWT Authentication Provider to a Node  |
| [`node get`](https://docs.vendia.com/share/cli/commands/node#node-get) | Get node configuration  |
| [`node grant-access`](https://docs.vendia.com/share/cli/commands/node#node-grant-access) | Grant user access to a Node  |
| [`node remove-jwt-auth`](https://docs.vendia.com/share/cli/commands/node#node-remove-jwt-auth) | Remove a custom JWT Authentication Provider from a Node  |
| [`node revoke-access`](https://docs.vendia.com/share/cli/commands/node#node-revoke-access) | Revoke a user's access to a Node  |
| [`node schema`](https://docs.vendia.com/share/cli/commands/node#node-schema) | Fetch a Node's GraphQL Schema  |
| [`node sharing-policy`](https://docs.vendia.com/share/cli/commands/node#node-sharing-policy) | Manage sharing policies for a node  |
| [`node update`](https://docs.vendia.com/share/cli/commands/node#node-update) | Update node configuration  |


### [share org](https://docs.vendia.com/share/cli/commands/org)

Manage your Organization (Enterprise only)

| Sub command | description  |
|:--------------------------- |:-----|
| [`org get`](https://docs.vendia.com/share/cli/commands/org#org-get) | Get your Organization (Enterprise only)  |
| [`org list-users`](https://docs.vendia.com/share/cli/commands/org#org-list-users) | List Org Users (Enterprise only)  |


### [share uni](https://docs.vendia.com/share/cli/commands/uni)

Manage Uni operations

| Sub command | description  |
|:--------------------------- |:-----|
| [`uni create`](https://docs.vendia.com/share/cli/commands/uni#uni-create) | Create a new uni  |
| [`uni delete`](https://docs.vendia.com/share/cli/commands/uni#uni-delete) | Permanently delete a uni  |
| [`uni evolve`](https://docs.vendia.com/share/cli/commands/uni#uni-evolve) | Evolve the schema for a Uni  |
| [`uni get`](https://docs.vendia.com/share/cli/commands/uni#uni-get) | Get information about a given uni  |
| [`uni invite`](https://docs.vendia.com/share/cli/commands/uni#uni-invite) | Invite a new node to join the Uni  |
| [`uni join`](https://docs.vendia.com/share/cli/commands/uni#uni-join) | Join an existing Uni  |
| [`uni list`](https://docs.vendia.com/share/cli/commands/uni#uni-list) | Lists all unis in your account  |
| [`uni open`](https://docs.vendia.com/share/cli/commands/uni#uni-open) | Open a Uni in the vendia dev console  |
| [`uni reset`](https://docs.vendia.com/share/cli/commands/uni#uni-reset) | Resets Uni to it's original state  |

David Wells

Builder of things

Serverless Architectures
User Experience & Product

Vendia CLI

About

API

Table of Contents

Install

Top level commands

All commands

share auth

share client

share file

share logout

share node

share org

share uni

Command	description
share auth	Manage authorization & set current Vendia user
share client	Manage your local Vendia client
share file	Manage files in a Uni
share login	Login to Vendia user account
share logout	Logout of Vendia user account
share node	Manage nodes in a Uni
share org	Manage your Organization (Enterprise only)
share uni	Manage Uni operations

Sub command	description
`auth login`	Login to Vendia user account
`auth logout`	Logout of Vendia user account
`auth role`	Manage roles for users
`auth role delete`	Delete roles for users
`auth role get`	Get role information
`auth role list`	List roles for user
`auth role set`	Set Roles for user
`auth switch`	Switch active Vendia account
`auth whoami`	Display active Vendia account

Sub command	description
`client generate`	Generate a custom client for your accessing your Uni's API.
`client pull`	Writes your Uni's schema files to a local directory - needed in order to generate a custom client for your accessing your Uni's API.

Sub command	description
`file add`	Add a file
`file get`	Get a file
`file list`	List current files
`file remove`	Remove a file
`file update`	Update a file

Sub command	description
`node add-api-key`	Add an API Key
`node add-jwt-auth`	Add a custom JWT Authentication Provider to a Node
`node get`	Get node configuration
`node grant-access`	Grant user access to a Node
`node remove-jwt-auth`	Remove a custom JWT Authentication Provider from a Node
`node revoke-access`	Revoke a user's access to a Node
`node schema`	Fetch a Node's GraphQL Schema
`node sharing-policy`	Manage sharing policies for a node
`node update`	Update node configuration

Sub command	description
`org get`	Get your Organization (Enterprise only)
`org list-users`	List Org Users (Enterprise only)

Sub command	description
`uni create`	Create a new uni
`uni delete`	Permanently delete a uni
`uni evolve`	Evolve the schema for a Uni
`uni get`	Get information about a given uni
`uni invite`	Invite a new node to join the Uni
`uni join`	Join an existing Uni
`uni list`	Lists all unis in your account
`uni open`	Open a Uni in the vendia dev console
`uni reset`	Resets Uni to it's original state