typehub-cli

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2024 License: MIT Imports: 2 Imported by: 0

README

TypeHub CLI

The CLI provides a simple binary written in go to access the https://typehub.cloud/ API. The following example shows how you can use the binary.

Build

To get the binary you can either use one of our pre-build binaries which you can download from our release page, or you can also simply build the binary by yourself with:

go build

Push

The push command creates or updates a document at TypeHub.

typehub push [document_name] [schema_file] --client-id="[user]" --client-secret="[password]"

  • document_name
    The name of your document
  • schema_file
    Contains the TypeAPI specification which you want to push to TypeHub
  • --client-id
    The client id is either your username or an app key which you can create at our backend.
  • --client-secret
    This client secret is either your password or an app secret which you can create at our backend.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL