Skip to content

Share CLI command - client

share client

Generate type-safe clients.

Table of Contents

Commands for share client

Manage your local Vendia client

Usage for share client

Terminal window
share client <subcommand>
Sub commanddescription
client generateGenerate a custom client for accessing your Uni’s API.
client pullWrites your Uni’s schema files to a local directory - needed in order to generate a custom client for accessing your Uni’s API.

Examples for share client

Terminal window
Manage Vendia client
share client:pull --uni <uniName>

client generate

Generate a custom client for accessing your Uni’s API.

Usage for client generate

Terminal window
share client generate

Flags for client generate

  • auth (option) - Vendia auth token used for overriding env variable or config values.
  • silent (boolean) - Silent all CLI output
  • json (boolean) - Output return values as JSON
  • debug (boolean) - Print debugging information

client pull

Writes your Uni’s schema files to a local directory - needed in order to generate a custom client for accessing your Uni’s API.

Usage for client pull

Terminal window
share client pull

Flags for client pull

  • uni (option) - Name of Uni
  • node (option) - Name of Node

Examples for client pull

Terminal window
share client:pull --uni <uniName>