swagger-wiki

• swagger-wiki
• Usage
• Commands
  • swagger-wiki help [COMMAND]
  • swagger-wiki update [PATH]
  • swagger-wiki update-gql [PATH]

swagger-wiki

A cli to create wiki pages in a project based on swagger files.

• Usage
• Commands

Usage

$ npm install -g swagger-wiki
$ swagger-wiki COMMAND
running command...
$ swagger-wiki (-v|--version|version)
swagger-wiki/1.0.17 linux-x64 node-v12.10.0
$ swagger-wiki --help [COMMAND]
USAGE
  $ swagger-wiki COMMAND
...

Commands

• swagger-wiki help [COMMAND]
• swagger-wiki update [PATH]
• swagger-wiki update-gql [PATH]

swagger-wiki help [COMMAND]

display help for swagger-wiki

USAGE
  $ swagger-wiki help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

swagger-wiki update [PATH]

Generate wiki pages from swagger files

USAGE
  $ swagger-wiki update [PATH]

ARGUMENTS
  PATH  Path to the swagger files

OPTIONS
  -h, --help               show CLI help
  -v, --usePackageVersion  Use the version in package.json
  --prefix=prefix          Hard coded prefix to use
  --project=project        GitLab project ID
  --token=token            GitLab private token to use

See code: src/commands/update.ts

swagger-wiki update-gql [PATH]

Generate wiki pages from graphql files

USAGE
  $ swagger-wiki update-gql [PATH]

ARGUMENTS
  PATH  Path to the graphql files

OPTIONS
  -h, --help         show CLI help
  --prefix=prefix    Hard coded prefix to use
  --project=project  GitLab project ID
  --token=token      GitLab private token to use

See code: src/commands/update-gql.ts