@sourceloop/cli

sourceloop-cli

This is a sourceloop based cli that provides commands to scaffold a monorepo, add extensions, facades and microservices to it.

Building

To install sourceloop-cli, run

npm install @sourceloop/cli

Usage

$ npm install -g @sourceloop/cli
$ sl COMMAND
running command...
$ sl (-v|--version|version)
@sourceloop/cli/9.2.0 linux-x64 node-v18.20.5
$ sl --help [COMMAND]
USAGE
  $ sl COMMAND
...

Commands

• sl autocomplete [SHELL]
• sl cdk
• sl extension [NAME]
• sl help [COMMAND]
• sl microservice [NAME]
• sl scaffold [NAME]
• sl update

sl autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ sl autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ sl autocomplete
  $ sl autocomplete bash
  $ sl autocomplete zsh
  $ sl autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

sl cdk

add arc-cdk

USAGE
  $ sl cdk

OPTIONS
  -a, --applicationClassName=applicationClassName  Class name of the service you want to deploy
  -d, --dir=dir                                    Name of the dir to store arc-cdk files
  -i, --iac=(lambda)                               iac for the service

  -o, --overwriteDockerfile                        Overwrite the existing Dockerfile for Lambda deployment (if it
                                                   exists)?

  -p, --packageJsonName=packageJsonName            Package name for arc-cdk

  -r, --relativePathToApp=relativePathToApp        Relative path to the service you want to deploy

  --help                                           show manual pages

See code: src/commands/cdk.ts

sl extension [NAME]

add an extension

USAGE
  $ sl extension [NAME]

ARGUMENTS
  NAME  Name of the extension

OPTIONS
  --help  show manual pages

See code: src/commands/extension.ts

sl help [COMMAND]

display help for sl

USAGE
  $ sl help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

sl microservice [NAME]

add a microservice

USAGE
  $ sl microservice [NAME]

ARGUMENTS
  NAME  Name of the microservice

OPTIONS
  -p, --uniquePrefix=uniquePrefix
      Unique prefix to be used for docker images

  -s, --baseService=(authentication-service|audit-service|chat-service|notification-service|bpmn-service|feature-toggle-
  service|in-mail-service|payment-service|scheduler-service|search-service|survey-service|task-service|video-conferencin
  g-service|user-tenant-service)
      Base ARC microservice

  --[no-]baseOnService
      Base on ARC microservice or not

  --customMigrations
      Setup custom migration for this microservice

  --datasourceName=datasourceName
      Name of the datasource to generate

  --datasourceType=(postgres|mysql)
      Type of the datasource

  --[no-]facade
      Create as facade

  --help
      show manual pages

  --includeMigrations
      Include base microservice migrations

  --sequelize
      Include sequelize as ORM in service

See code: src/commands/microservice.ts

sl scaffold [NAME]

create a project scaffold

USAGE
  $ sl scaffold [NAME]

ARGUMENTS
  NAME  name of the project

OPTIONS
  --cwd=cwd                  Directory where project will be scaffolded, instead of the project name
  --description=description  description of the repo
  --helmPath=helmPath        Enter the path for Helm chart:
  --help                     show manual pages
  --integrateWithBackstage   Do you want to include backstage integration files?
  --issuePrefix=issuePrefix  Prefix to be used for issues(e.g. GH-)
  --jenkinsfile              Do you want to create a Jenkinsfile for Helm-based deployment on Kubernetes?
  --owner=owner              owner of the repo

See code: src/commands/scaffold.ts

sl update

update the dependencies of a loopback project

USAGE
  $ sl update

OPTIONS
  --help  show manual pages

See code: src/commands/update.ts