endpoints-sdk-cli

matsuri-tech/endpoints-sdk-cli (mes)

Endpoints SDK for JavaScript

※ Include the generated endpoint files in commits.

• Usage
• Commands
• Support of create-react-app
• Override root url

Usage

$ npm install -g endpoints-sdk-cli
$ mes COMMAND
running command...
$ mes (-v|--version|version)
endpoints-sdk-cli/2.8.0 darwin-arm64 node-v18.19.0
$ mes --help [COMMAND]
USAGE
  $ mes COMMAND
...

Commands

• mes add [REPOSITORY]
• mes help [COMMAND]
• mes install
• mes update [SERVICE]

mes add [REPOSITORY]

add service to dependencies & make endpoints files.

USAGE
  $ mes add [REPOSITORY]

OPTIONS
  -b, --branch=branch        branch name to clone
  -e, --excludes=excludes    exclude periods
  -v, --version=version      latest or commit hash
  -w, --workspace=workspace  a path to workspace containing .endpoints.json

DESCRIPTION
  add service to dependencies & make endpoints files.

  1. make endpoints.config.json for version control.

  {
    "dependencies": {
      "service-name": {
        "version": "26177ed7e673daf0cc5a69e9793dd863424d272f",
        "repository": "[e-mail]:[username/repository].git"
      }
    }
  }

  > service name is inferred from Repository name.

  2. make src/endpoints/[service-name].ts

EXAMPLES
  $ mes add [username/repository]
  $ mes add [username/repository] --version [commmit hash]
  $ mes add [username/repository] -v [commmit hash]
  $ mes add [username/repository] -v latest
  $ mes add [username/repository] --workspace [workspace directory]
  $ mes add [username/repository] -w [workspace directory]
  $ mes add [username/repository] --branch [branch name]
  $ mes add [username/repository] -b [branch name]
  $ mes add [username/repository] --excludes [period name]
  $ mes add [username/repository] -e [period name]
  $ mes add [username/repository] -e [period name] [period name]
  $ mes add /Users/.../local-repository/
  $ mes add ./local-repository
  $ mes add [e-mail]:[username/repository].git
  $ mes add https://github.com/[username/repository].git

See code: src/commands/add.ts

mes help [COMMAND]

display help for mes

USAGE
  $ mes help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

mes install

generate endpoints files based on endpoints.config.json

USAGE
  $ mes install

See code: src/commands/install.ts

mes update [SERVICE]

update service version & regenerate endpoints files

USAGE
  $ mes update [SERVICE]

See code: src/commands/update.ts

Support of create-react-app

{
  "environment_identifier": "process.env.REACT_APP_ENV",
}

Override root url

{
  "dependencies": {
    "my-service": {
      "version": "ba832b61d0319f42b3cbb30c815cbdecfece959a",
      "repository": "[e-mail]:hoge/my-service.git",
      "roots":{
        "dev": "https://dev.hoge.com",
        "prod": "https://hoge.com",
        "local": "http://localhost:3000"
      }
    },
  }
}