Using the Share CLI

Welcome to the Vendia Share CLI!

Install the CLI

To install the CLI, pop open your terminal and install with npm.

npm install @vendia/share-cli -g

Listing commands

To get a list of commands, run:

share help

To get a list of available sub-commands, arguments, and flags, run:

share [command] --help

Commands

Manage authorization & set current Vendia user

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

Manage your local Vendia client

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.

Manage files in a Uni

Logout of Vendia user account

Manage nodes in a Uni

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

Manage your Organization (Enterprise only)

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

Manage Uni operations

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