Share CLI command - uni

`share uni`

Manage Uni operations.

Table of Contents

uni create
uni delete
uni evolve
uni get
uni invite
uni join
uni list
uni open
uni reset

Commands

Manage Uni operations

Usage

share uni <subcommand>

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

Examples

❯ List all uni info
share uni list

❯ Get Uni info
share uni get --uni <uniName>

❯ Create Unis
# Register uni via JSON file:
share uni:create --config registration.json
# Register uni via --config:
share uni:create --config '{"name": "test-UniName", "schema": "schema.json","nodes":[{"name":"NodeName","userId": "email@email.com","region": "us-east-1","csp": "aws"}]}'

❯ Open Unis in Browser
share uni open
share uni open --uni <uniName>

❯ Reset Uni data
share uni reset --uni <uniName>

❯ Delete Uni
share uni delete --uni <uniName>
# Skip delete confirmation prompt:
share uni delete --uni <uniName> --force

❯ Invite another node to the Uni
share uni invite --uni <uniName> --user <userEmail>

❯ Join an existing Uni
share uni join -u <uniName> -t <token> --config '{"name":"nodeName", "userId":"email@email.com", "region":"us-east-1"}'
share uni join --uni <uniName> --token <token> --config '{"name":"nodeName", "userId":"email@email.com", "region":"us-east-1"}'

❯ Evolve the schema of a Uni
share uni evolve --uni <uniName> --schema schema.json

`uni create`

Create a new uni

The uni create command also allows for optionally providing the schema and initial state filenames as an alternative to providing them in the registration file.

Usage

share uni create

Flags

config (option) - File path or JSON registration data
role (option) - Role name to use for the operation

Examples

# Register uni via JSON file:
share uni:create --config registration.json
# Register uni via --config:
share uni:create --config '{"name": "test-UniName", "schema": "schema.json","nodes":[{"name":"NodeName","userId": "email@email.com","region": "us-east-1","csp": "aws"}]}'

`uni delete`

Permanently delete a uni

Usage

share uni delete

Flags

uni (option) - Name of Uni
force (boolean) - Force deletion with no confirmation step. Use with caution
role (option) - Role name to use for the operation

Examples

share uni delete --uni <uniName>
# Skip delete confirmation prompt:
share uni delete --uni <uniName> --force

`uni evolve`

Evolve the schema for a Uni

Usage

share uni evolve

Flags

uni (option) - Name of Uni
schema (option) - File path of schema
allowed-breaking-change (option) - A type of breaking change allowed. This flag may be specified multiple times to allow more than one type of breaking change.
approval-required (option) - Interactive approval for breaking changes to a schema. Default is ‘ALWAYS’
role (option) - Role name to use for the operation

Examples

share uni evolve --uni <uniName> --schema schema.json

`uni get`

Get information about a given uni

Usage

share uni get

Flags

uni (option) - Name of Uni
role (option) - Role name to use for the operation

Examples

share uni get --uni <uniName>

`uni invite`

Invite a new node to join the Uni

Usage

share uni invite

Flags

uni (option) - Name of Uni
user (option) - User email of user to invite
role (option) - Role name to use for the operation

Examples

share uni invite --uni <uniName> --user <userEmail>

`uni join`

Join an existing Uni

Usage

share uni join

Flags

uni (option) - Name of Uni
token (option) - Value of the invitation token
config (option) - Node configuration settings
json (boolean) - Output return values as JSON
role (option) - Role name to use for the operation

Examples

share uni join -u <uniName> -t <token> --config '{"name":"nodeName", "userId":"email@email.com", "region":"us-east-1"}'
share uni join --uni <uniName> --token <token> --config '{"name":"nodeName", "userId":"email@email.com", "region":"us-east-1"}'

`uni list`

Lists all unis in your account Lists all unis in which the calling account owns a node.

Usage

share uni list

Flags

json (boolean) - Return list of unis as json
role (option) - Role name to use for the operation

Examples

share uni list

`uni open`

Open a Uni in the vendia dev console

Usage

share uni open

Flags

uni (option) - Name of Uni

Examples

share uni open
share uni open --uni <uniName>

`uni reset`

Resets Uni to it’s original state Resets uniName to the state it was in just after it began operation (useful during development and testing).

Usage

share uni reset

Flags

uni (option) - Name of Uni
role (option) - Role name to use for the operation

Examples

share uni reset --uni <uniName>