Telar-cli NPM | npm.io

Telar CLI

This is a CLI to scaffold, build and deploy.

Usage

$ npm install -g telar-cli
$ telar COMMAND
running command...
$ telar (--version)
telar-cli/0.20.29 darwin-arm64 node-v21.5.0
$ telar --help [COMMAND]
USAGE
  $ telar COMMAND
...

Commands

`telar create SOLUTION`

Create a project from a template

USAGE
  $ telar create SOLUTION [-d <value>] [-f <value>] [-g <value>] [-h] [-o <value>] [-t <value>]

ARGUMENTS
  SOLUTION  Solution name to create a project

FLAGS
  -d, --dir=<value>       Aternative direcoty to telar solutions repository
  -f, --file=<value>      Alternative to default telar store repository. The path example `path/to/solution.json`
  -g, --git=<value>
  -h, --help              Show CLI help.
  -o, --output=<value>    [default: .]
  -t, --template=<value>

DESCRIPTION
  Create a project from a template

EXAMPLES
  $ telar create telar-social

See code: src/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: src/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: src/commands/platform.ts

`telar plugins`

List installed plugins.

USAGE
  $ telar plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ telar plugins

See code: @oclif/plugin-plugins

`telar plugins add PLUGIN`

Installs a plugin into telar.

USAGE
  $ telar plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into telar.

  Uses bundled npm executable to install plugins into /Users/qolzam/.local/share/telar

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

  Use the TELAR_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the TELAR_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ telar plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ telar plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ telar plugins add 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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ telar plugins inspect myplugin

See code: @oclif/plugin-plugins

`telar plugins install PLUGIN`

Installs a plugin into telar.

USAGE
  $ telar plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into telar.

  Uses bundled npm executable to install plugins into /Users/qolzam/.local/share/telar

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

  Use the TELAR_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the TELAR_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ telar plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ telar plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ telar plugins install someuser/someplugin

See code: @oclif/plugin-plugins

`telar plugins link PATH`

Links a plugin into the CLI for development.

USAGE
  $ telar plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

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

See code: @oclif/plugin-plugins

`telar plugins remove [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ telar plugins remove [PLUGIN...] [-h] [-v]

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

EXAMPLES
  $ telar plugins remove myplugin

`telar plugins reset`

Remove all user-installed and linked plugins.

USAGE
  $ telar plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

`telar plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ telar plugins uninstall [PLUGIN...] [-h] [-v]

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

EXAMPLES
  $ telar plugins uninstall myplugin

See code: @oclif/plugin-plugins

`telar plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ telar plugins unlink [PLUGIN...] [-h] [-v]

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

EXAMPLES
  $ telar plugins unlink myplugin

`telar plugins update`

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

`telar run`

run a server for Telar micro-services

USAGE
  $ telar run [-d <value>] [-h] [-p <value>] [-s <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
  -s, --server=<value>  External server path

DESCRIPTION
  run a server for Telar micro-services

EXAMPLES
  $ telar run

See code: src/commands/run.ts

`telar seal [FILE]`

add a server-less target

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

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: src/commands/seal.ts

`telar service [CALL] [PATH]`

run a service

USAGE
  $ telar service [CALL] [PATH] [--config <value>] [-h]

FLAGS
  -h, --help            Show CLI help.
  --config=<value>

DESCRIPTION
  run a service

EXAMPLES
  $ telar service run .

See code: src/commands/service.ts

`telar solution [COMMAND] [SERVICE]`

Manage solutions

USAGE
  $ telar solution [COMMAND] [SERVICE] [--exclude <value>] [-h]

ARGUMENTS
  COMMAND  Command to run
  SERVICE  Service name

FLAGS
  -h, --help                Show CLI help.
      --exclude=<value>...  [default: ] exclude a service

DESCRIPTION
  Manage solutions

EXAMPLES
  $ telar solution

See code: src/commands/solution.ts

`telar sync [TARGET]`

sync @telar/core project with target platform

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

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: src/commands/sync.ts

oclif