Telar-cli NPM | npm.io

telar-cli

Telar necessary tools

Usage

$ npm install -g telar-cli
$ telar COMMAND
running command...
$ telar (--version)
telar-cli/0.15.0 darwin-arm64 node-v16.17.0
$ telar --help [COMMAND]
USAGE
  $ telar COMMAND
...

Commands

`telar create SOLUTION`

Create a project template

USAGE
  $ telar create [SOLUTION] [-h] [-t <value>] [-c <value>] [-o <value>]

ARGUMENTS
  SOLUTION  Solution name to start a project

FLAGS
  -c, --config=<value>    [default: ./conf.yml]
  -h, --help              Show CLI help.
  -o, --output=<value>    [default: .]
  -t, --template=<value>

DESCRIPTION
  Create a project template

EXAMPLES
  $ telar create telar-social

  $ telar create telar-social --template="telar-social-raw"

  $ telar create telar-social --template="telar-social-raw" --output ./path/to/output

See code: dist/commands/create.ts

`telar help [COMMAND]`

Display help for telar.

USAGE
  $ telar help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for telar.

See code: @oclif/plugin-help

`telar html [ARG0] [PATH]`

compile html template file to a Javascript compile function

USAGE
  $ telar html [ARG0] [PATH] [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  compile html template file to a Javascript compile function

EXAMPLES
  $ telar html compile ./auth

See code: dist/commands/html.ts

`telar platform [ARG1] [ARG2]`

Fetch platforms which using @telar/core project

USAGE
  $ telar platform [ARG1] [ARG2] [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Fetch platforms which using @telar/core project

EXAMPLES
  $ telar platform

  $ telar platform pull https://github.com/Qolzam/platforms.git

See code: dist/commands/platform.ts

`telar plugins`

List installed plugins.

USAGE
  $ telar plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ telar plugins

See code: @oclif/plugin-plugins

`telar plugins:install PLUGIN...`

Installs a plugin into the CLI.

USAGE
  $ telar plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ telar plugins add

EXAMPLES
  $ telar plugins:install myplugin 

  $ telar plugins:install https://github.com/someuser/someplugin

  $ telar plugins:install someuser/someplugin

`telar plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

USAGE
  $ telar plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ telar plugins:inspect myplugin

`telar plugins:install PLUGIN...`

Installs a plugin into the CLI.

USAGE
  $ telar plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ telar plugins add

EXAMPLES
  $ telar plugins:install myplugin 

  $ telar plugins:install https://github.com/someuser/someplugin

  $ telar plugins:install someuser/someplugin

`telar plugins:link PLUGIN`

Links a plugin into the CLI for development.

USAGE
  $ telar plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES
  $ telar plugins:link myplugin

`telar plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ telar plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ telar plugins unlink
  $ telar plugins remove

`telar plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ telar plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ telar plugins unlink
  $ telar plugins remove

`telar plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ telar plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ telar plugins unlink
  $ telar plugins remove

`telar plugins update`

Update installed plugins.

USAGE
  $ telar plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

`telar proxy`

run a proxy server

USAGE
  $ telar proxy [-h] [-p <value>] [-t <value>]

FLAGS
  -h, --help            Show CLI help.
  -p, --port=<value>    [default: 80] Income port
  -t, --target=<value>  [default: http://social.example.com:4000] Proxy server target

DESCRIPTION
  run a proxy server

EXAMPLES
  $ telar proxy -p 80 -t http://social.example.com:4000

See code: dist/commands/proxy.ts

`telar run`

run a server for Telar micro-services

USAGE
  $ telar run [-h] [-d <value>] [-p <value>]

FLAGS
  -d, --dir=<value>...  [default: ] The directory for micro-services
  -h, --help            Show CLI help.
  -p, --port=<value>    [default: 3000] The port that server listen to

DESCRIPTION
  run a server for Telar micro-services

EXAMPLES
  $ telar run

See code: dist/commands/run.ts

`telar seal [FILE]`

add a server-less target

USAGE
  $ telar seal [FILE] [-h] [-g <value>] [--pk-base64] [-o <value>] [-c <value>] [-l <value>] [-i <value>]

FLAGS
  -c, --cert=<value>          [default: secret-public.key] The path to the public key file. Default is secret-public.key
  -g, --gen=<value>           Generate key pair
  -h, --help                  Show CLI help.
  -i, --from-file=<value>...  Secret literal key-value data
  -l, --literal=<value>...    Secret literal key-value data
  -o, --output-file=<value>   [default: secrets.yml] Output file for secrets
  --pk-base64                 Whether generate base64 version of private key or not

DESCRIPTION
  add a server-less target

EXAMPLES
    telar seal --literal db-pass=p@55w0rd
    telar seal --from-file api-key.txt
    telar seal --literal a=b --literal c=d --cert public.key --output-file secrets.yml
    telar seal --gen secret --pk-base64

See code: dist/commands/seal.ts

`telar sync [TARGET]`

sync @telar/core project with target platform

USAGE
  $ telar sync [TARGET] [-h] [-f <value>]

FLAGS
  -f, --file=<value>  [default: stack.yml] Stack file path
  -h, --help          Show CLI help.

DESCRIPTION
  sync @telar/core project with target platform

EXAMPLES
  $ telar sync vercel

See code: dist/commands/sync.ts

oclif