@telepath/cli

This package exposes a cli tool to interact with the telepath runtime

Installation

> npm install -g @telepath/cli

Usage

init

You can initialize telepath projects easy and conventient using:

> telepath init
> telepath init help

USAGE
  $ telepath init

OPTIONS
  -a, --enableAnalytics                        enable analytics, it is used to improve the stability for develpers
  -f, --entryPointFiles=entryPointFiles        glob pattern to find your entrypoint files, i.e. packages/**/*.{ts,js}
  -h, --help                                   show CLI help
  -o, --outputFile=outputFile                  define the output path for the telepath.yml file
  --projectId=projectId                    project id

auth:login

authenticate your CLI using a telepath auth token

> telepath auth:login --token={your-token-here}
> telepath auth:login --help

Authenticate your CLI through token

USAGE
  $ telepath auth:login

OPTIONS
  -h, --help         show CLI help
  -t, --token=token  telepath token used to authenticate your CLI

deploy:components

Deploy your components

> telepath deploy:components
> telepath deploy:components --help

USAGE
  $ telepath deploy:components

OPTIONS
  -f, --file=file        telepath.yml location file, by default is used the path: ./telepath.yml
  -h, --help             show CLI help
  -v, --verbose=verbose  set verbose level
  -y, --confirm          autoconfirm the deployment

deploy:functions

call functions defined in your telepath project

> telepath deploy:functions --help

USAGE
  $ telepath deploy:functions

OPTIONS
  -f, --file=file                  telepath.yml location file, by default is used the path: ./telepath.yml
  -h, --help                       show CLI help
  -n, --functionName=functionName  specify what function to deploy an call
  -v, --verbose=verbose            set verbose level
  -y, --confirm                    autoconfirm the deployment

state:export

export you're telepath state to fix it manually

> telepath state:export --help

USAGE
  $ telepath state:export

OPTIONS
  -f, --file=file        telepath.yml location file, by default is used the path: ./telepath.yml
  -h, --help             show CLI help
  -o, --output=output    (required) JSON file where the state will be exported
  -v, --verbose=verbose  set verbose level

state:import

import you're telepath state

> telepath state:import --help

USAGE
  $ telepath state:import

OPTIONS
  -f, --file=file            telepath.yml location file, by default is used the path: ./telepath.yml
  -h, --help                 show CLI help
  -s, --stateFile=stateFile  (required) State JSON file to be imported
  -v, --verbose=verbose      set verbose level

Documentation

Read the documentation here or build it:

$ npn install
$ npm run docs