smocks-cli

Manage your servicemocks.com resources locally

• Usage
• Commands

Usage

$ npm install -g smocks-cli
$ smocks-cli COMMAND
running command...
$ smocks-cli (-v|--version|version)
smocks-cli/1.0.10 darwin-x64 node-v18.18.2
$ smocks-cli --help [COMMAND]
USAGE
  $ smocks-cli COMMAND
...

Commands

• smocks-cli config:get
• smocks-cli config:set
• smocks-cli contract:push
• smocks-cli help [COMMAND]
• smocks-cli services:pull
• smocks-cli services:push

smocks-cli config:get

get cli config info

USAGE
  $ smocks-cli config:get

See code: src/commands/config/get.js

smocks-cli config:set

set cli config info

USAGE
  $ smocks-cli config:set

OPTIONS
  -k, --api-key=api-key            servicemocks.com api key
  -u, --api-url-root=api-url-root  [default: https://servicemocks.com] url to api

See code: src/commands/config/set.js

smocks-cli contract:push

push local swagger spec (.yaml, .json) to servicemocks.com

USAGE
  $ smocks-cli contract:push

OPTIONS
  -k, --api-key=api-key      servicemocks.com api key. will pull from saved config otherwise specified
  -p, --file-path=file-path  (required) file path to contract

See code: src/commands/contract/push.js

smocks-cli help [COMMAND]

display help for smocks-cli

USAGE
  $ smocks-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

smocks-cli services:pull

pull and store service definitions locally

USAGE
  $ smocks-cli services:pull

OPTIONS
  -d, --work-dir=work-dir  [default: .svcmocks] relative directory to store services in
  -e, --existing           pull every service already present in services directory
  -i, --indent=indent      [default: 2] spaces applied to service json when saved
  -j, --json               write as json
  -k, --api-key=api-key    servicemocks.com api key. will pull from saved config otherwise specified
  -q, --query=query        text query to check for in service names to narrow results
  -s, --services=services  comma separated list of service names to pull

See code: src/commands/services/pull.js

smocks-cli services:push

push local service definitions to servicemocks.com

USAGE
  $ smocks-cli services:push

OPTIONS
  -d, --work-dir=work-dir  [default: .svcmocks] relative directory to push services
  -f, --force              skip warning prompt
  -k, --api-key=api-key    servicemocks.com api key. will pull from saved config otherwise specified
  -p, --patch              patch services with data specified for each service
  -s, --services=services  comma separated list of service names to push

See code: src/commands/services/push.js