@vendia/share-cli

0.12.9 • Public • Published

Vendia Share CLI

Version Downloads/week License

Interact with Vendia from the comfort of your CLI.

See the command line reference to get started and the docs on using Vendia.

Table of Contents

Click to expand

Install

Install the CLI globally

npm install @vendia/share-cli -g

Or install locally without the -g global flag

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

share --help

Top level commands

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

All 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

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

Login to Vendia user account

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

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.12.9
    10
    • latest

Version History

Package Sidebar

Install

npm i @vendia/share-cli

Weekly Downloads

85

Version

0.12.9

License

MIT

Unpacked Size

292 kB

Total Files

102

Last publish

Collaborators

  • silversteez
  • davidwells
  • brettstack
  • vendibot