symphony-cli

quick symphony server cli tools

• Usage
• Commands

Usage

$ npm install -g @stechquick/symphony-cli
$ symphony-cli COMMAND
running command...
$ symphony-cli (-v|--version|version)
@stechquick/symphony-cli/0.5.31 linux-x64 node-v16.20.2
$ symphony-cli --help [COMMAND]
USAGE
  $ symphony-cli COMMAND
...

Commands

• symphony-cli help [COMMAND]
• symphony-cli mui-create NAME
• symphony-cli nc-addcomp NAME
• symphony-cli nc-build
• symphony-cli nc-create NAME
• symphony-cli qui-build
• symphony-cli qui-create NAME
• symphony-cli qui-start
• symphony-cli quick-serve
• symphony-cli studio-sync
• symphony-cli sym-addfunc FUNCNAME
• symphony-cli sym-build
• symphony-cli sym-create NAME
• symphony-cli sym-create-module NAME
• symphony-cli sym-fn-deploy ENVIRONMENT
• symphony-cli sym-nano-deploy
• symphony-cli sym-start
• symphony-cli sym-test

symphony-cli help [COMMAND]

display help for symphony-cli

USAGE
  $ symphony-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

symphony-cli mui-create NAME

MicroUI command to create a new Micro UI project

USAGE
  $ symphony-cli mui-create NAME

ARGUMENTS
  NAME  input microui name

OPTIONS
  -d, --desc=desc  description to project

EXAMPLE
  symphony-cli mui-create myUI -d="My Micro UI project"

See code: src/commands/mui-create.ts

symphony-cli nc-addcomp NAME

Command for add a named component to nc project.

USAGE
  $ symphony-cli nc-addcomp NAME

ARGUMENTS
  NAME  input component name

EXAMPLE
  symphony-cli nc-addcomp my_comp_name

See code: src/commands/nc-addcomp.ts

symphony-cli nc-build

Command for build your named component project.

USAGE
  $ symphony-cli nc-build

OPTIONS
  -w, --watch  for watch

EXAMPLES
  $ symphony-cli nc-build
  $ symphony-cli nc-build -w

See code: src/commands/nc-build.ts

symphony-cli nc-create NAME

Command for create a named component template project.

USAGE
  $ symphony-cli nc-create NAME

ARGUMENTS
  NAME  input project name

OPTIONS
  -d, --desc=desc  description to named component

EXAMPLE
  symphony-cli nc-create nc_example -d="my named component example"

See code: src/commands/nc-create.ts

symphony-cli qui-build

Plateau-QUI command to build your Quick ui project

USAGE
  $ symphony-cli qui-build

EXAMPLE
  $ symphony-cli qui-build -w

See code: src/commands/qui-build.ts

symphony-cli qui-create NAME

Plateau-QUI command to create a new Quick ui project

USAGE
  $ symphony-cli qui-create NAME

ARGUMENTS
  NAME  input quick ui name

OPTIONS
  -d, --desc=desc    description to project
  -t, --token=token  (required) npm token for @stechquick

EXAMPLES
  symphony-cli qui-create myUI -t=TOKEN
  symphony-cli qui-create myUI -t=TOKEN -d="My Quick UI project"

See code: src/commands/qui-create.ts

symphony-cli qui-start

Plateau-QUI command for start your Quick ui project with/without build

USAGE
  $ symphony-cli qui-start

OPTIONS
  -b, --build  for build

EXAMPLE
  $ symphony-cli qui-start -b

See code: src/commands/qui-start.ts

symphony-cli quick-serve

QUICK command for serving your path

USAGE
  $ symphony-cli quick-serve

OPTIONS
  -g, --global             Host/visible for everyone.
  -p, --httpPort=httpPort  HTTP port to serve
  -r, --path=path          Change path to serve

EXAMPLES
  $ symphony-cli quick-serve
  $ symphony-cli quick-serve -p 3000
  $ symphony-cli quick-serve -g
  $ symphony-cli quick-serve -r C:/MyPathToServe
  $ symphony-cli quick-serve -g -r C:/MyPathToServe

See code: src/commands/quick-serve.ts

symphony-cli studio-sync

Studio command for serving your path

USAGE
  $ symphony-cli studio-sync

OPTIONS
  -g, --global             Host/visible for everyone.
  -p, --httpPort=httpPort  HTTP port to serve
  -r, --path=path          Change path to serve

EXAMPLE
  $ symphony-cli studio-sync

See code: src/commands/studio-sync.ts

symphony-cli sym-addfunc FUNCNAME

Plateau-Symphony command to create a new function

USAGE
  $ symphony-cli sym-addfunc FUNCNAME

ARGUMENTS
  FUNCNAME  input function name

EXAMPLE
  symphony-cli sym-addfunc havalemenu

See code: src/commands/sym-addfunc.ts

symphony-cli sym-build

Plateau-Symphony command to build the app with/without watch

USAGE
  $ symphony-cli sym-build

OPTIONS
  -i, --swaggerInclusive                       to make swagger schema inclusive

  -l, --local_js_dist_path=local_js_dist_path  for monorepos, if local.js is not directly under dist. like:
                                               ./dist/api/local.js

  -s, --skipversion                            skip version checking. Used for Deployment

  -w, --watch                                  for watch

  --swagger                                    for swagger generation, this parameter must be given

EXAMPLES
  $ symphony-cli sym-build
  $ symphony-cli sym-build -w
  $ symphony-cli sym-build --swagger
  $ symphony-cli sym-build --swagger -i
  $ symphony-cli sym-build --swagger -l ./dist/api/local.js

See code: src/commands/sym-build.ts

symphony-cli sym-create NAME

Plateau-Symphony command to create a Symphony App

USAGE
  $ symphony-cli sym-create NAME

ARGUMENTS
  NAME  input application name

OPTIONS
  -d, --desc=desc    description to application
  -t, --token=token  (required) npm token for @stechquick

EXAMPLE
  symphony-cli sym-create havale -d="Kanallardan yapılan havale işlemi"

See code: src/commands/sym-create.ts

symphony-cli sym-create-module NAME

Plateau-Symphony command to create a Symphony Library (Module)

USAGE
  $ symphony-cli sym-create-module NAME

ARGUMENTS
  NAME  input module name

OPTIONS
  -d, --desc=desc  description to module

EXAMPLE
  symphony-cli sym-create-module abm -d="abm module description"

See code: src/commands/sym-create-module.ts

symphony-cli sym-fn-deploy ENVIRONMENT

Plateau-Symphony fn command to deploy the all functions in your app

USAGE
  $ symphony-cli sym-fn-deploy ENVIRONMENT

ARGUMENTS
  ENVIRONMENT  (local|play|remote) deploy environment:
               [local: your local]
               [play: playground environment]
               [remote: remote server]

OPTIONS
  -d, --d_url=d_url        docker url to deploy
  -e, --node_env=node_env  symphony environment name
  -f, --f_url=f_url        fn api url to deploy
  -p, --d_pass=d_pass      docker password for this username to deploy
  -u, --d_user=d_user      docker username to deploy

EXAMPLES
  symphony-cli sym-fn-deploy local
  symphony-cli sym-fn-deploy play
  symphony-cli sym-fn-deploy remote
  symphony-cli sym-fn-deploy remote -d MyDockerUrl -u MyDockerUser -p MyDockerPassword -f MyFnApiUrl
  symphony-cli sym-fn-deploy remote --d_url MyDockerUrl --d_user MyDockerUser --d_pass MyDockerPassword --f_url 
  MyFnApiUrl
  symphony-cli sym-fn-deploy remote --d_url="MyDockerUrl" --d_user="MyDockerUser" --d_pass="MyDockerPassword" 
  --f_url="MyFnApiUrl"

See code: src/commands/sym-fn-deploy.ts

symphony-cli sym-nano-deploy

Plateau-Symphony nano command to deploy the all functions in your app

USAGE
  $ symphony-cli sym-nano-deploy

OPTIONS
  -e, --node_env=node_env    symphony environment name
  -i, --imagename=imagename  (required) image name for docker

EXAMPLE
  symphony-cli sym-nano-deploy

See code: src/commands/sym-nano-deploy.ts

symphony-cli sym-start

Plateau-Symphony command to start your functions with/without debug

USAGE
  $ symphony-cli sym-start

OPTIONS
  -b, --build                                  for build
  -d, --debug                                  for debug
  -e, --environment=environment                environment variable
  -h, --https_port=https_port                  port to HTTPS server

  -l, --local_js_dist_path=local_js_dist_path  for monorepos, if local.js is not directly under dist. like:
                                               ./dist/api/local.js

  -p, --http_port=http_port                    port to HTTP server

  --hosted_path=hosted_path                    application hosted sub path

EXAMPLES
  $ symphony-cli sym-start -b -d
  $ symphony-cli sym-start -l ./dist/api/local.js

See code: src/commands/sym-start.ts

symphony-cli sym-test

Plateau-Symphony command to run your all test functions with coverage

USAGE
  $ symphony-cli sym-test

OPTIONS
  -f, --func=func  funtion name to test particular file

EXAMPLE
  $ symphony-cli sym-test

See code: src/commands/sym-test.ts