json-serverless

cli for json-serverless project

• json-serverless
• Usage
• Commands

Usage

$ npm install -g json-serverless
$ jsonsls COMMAND
running command...
$ jsonsls (-v|--version|version)
json-serverless/1.6.16 linux-x64 node-v10.24.0
$ jsonsls --help [COMMAND]
USAGE
  $ jsonsls COMMAND
...

Commands

• jsonsls create-stack FILE [STAGE]
• jsonsls help [COMMAND]
• jsonsls run FILE
• jsonsls update-stack [STAGE]
• jsonsls validate FILE

jsonsls create-stack FILE [STAGE]

create the stackfolder and deploy the stack in the cloud

USAGE
  $ jsonsls create-stack FILE [STAGE]

ARGUMENTS
  FILE   path of JSON file
  STAGE  [default: dev] stage name

OPTIONS
  -a, --apikeyauth                 require api key authentication to access api
  -d, --description=description    api description
  -h, --help                       show CLI help
  -i, --region=region              AWS region
  -l, --loglevel=info|debug        [default: info] loglevel of outputs
  -n, --name=name                  api name
  -r, --readonly                   set api to readonly (true) or writeable (false)
  -s, --[no-]swagger               enable or disable swagger interface support
  -y, --autoapprove                skip interactive approval before deployment
  --apiRoute=apiRoute              [default: /api] path to use for api route
  --apikey=apikey                  set a specific api key - if not set a random key will be generated
  --apispecRoute=apispecRoute      [default: /api-spec] path for the swagger / open api specification
  --graphqlRoute=graphqlRoute      [default: /graphql] path for the graphql interface
  --swaggeruiRoute=swaggeruiRoute  [default: /ui] path for the swagger ui interface

See code: lib/commands/create-stack.js

jsonsls help [COMMAND]

display help for jsonsls

USAGE
  $ jsonsls help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

jsonsls run FILE

run and test the api locally

USAGE
  $ jsonsls run FILE

ARGUMENTS
  FILE  path of JSON file

OPTIONS
  -a, --apikeyauth                 enable api key authentication to access api
  -h, --help                       show CLI help
  -l, --loglevel=info|debug        [default: info] loglevel of outputs
  -r, --readonly                   set api to readonly (true) or writeable (false)
  -s, --[no-]swagger               enable or disable swagger interface support
  --apiRoute=apiRoute              [default: /api] path to use for api route
  --apikey=apikey                  set a specific api key - if not set a random key will be generated
  --apispecRoute=apispecRoute      [default: /api-spec] path for the swagger / open api specification
  --graphqlRoute=graphqlRoute      [default: /graphql] path for the graphql interface
  --swaggeruiRoute=swaggeruiRoute  [default: /ui] path for the swagger ui interface

See code: lib/commands/run.js

jsonsls update-stack [STAGE]

update the stackfolder and update the stack in the cloud

USAGE
  $ jsonsls update-stack [STAGE]

ARGUMENTS
  STAGE  [default: dev] stage name

OPTIONS
  -a, --apikeyauth                         require api key authentication to access api
  -h, --help                               show CLI help
  -l, --loglevel=info|debug                [default: info] loglevel of outputs
  -p, --currentdirectory=currentdirectory  current working directory that will be used for execution
  -r, --readonly                           set api to readonly (true) or writeable (false)
  -s, --[no-]swagger                       enable or disable swagger interface support
  --apiRoute=apiRoute                      [default: /api] path to use for api route
  --apikey=apikey                          set a specific api key - if not set a random key will be generated
  --apispecRoute=apispecRoute              [default: /api-spec] path for the swagger / open api specification
  --graphqlRoute=graphqlRoute              [default: /graphql] path for the graphql interface
  --swaggeruiRoute=swaggeruiRoute          [default: /ui] path for the swagger ui interface

See code: lib/commands/update-stack.js

jsonsls validate FILE

validate the json file against specific rules

USAGE
  $ jsonsls validate FILE

ARGUMENTS
  FILE  path of JSON file

OPTIONS
  -h, --help          show CLI help
  -s, --[no-]swagger  enable or disable swagger interface support

See code: lib/commands/validate.js