dbdocs

dbdocs

• Usage
• Commands

Usage

$ npm install -g dbdocs
$ dbdocs COMMAND
running command...
$ dbdocs (-v|--version|version)
dbdocs/0.3.0 linux-x64 node-v12.14.1
$ dbdocs --help [COMMAND]
USAGE
  $ dbdocs COMMAND
...

Commands

• dbdocs build [FILEPATH]
• dbdocs help [COMMAND]
• dbdocs login
• dbdocs logout
• dbdocs password
• dbdocs remove [PROJECT_NAME]

dbdocs build [FILEPATH]

build docs

USAGE
  $ dbdocs build [FILEPATH]

ARGUMENTS
  FILEPATH  dbml file path

OPTIONS
  -p, --password=password  password for project
  --project=project        project name

See code: src/commands/build.js

dbdocs help [COMMAND]

display help for dbdocs

USAGE
  $ dbdocs help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

dbdocs login

login to dbdocs

USAGE
  $ dbdocs login

DESCRIPTION
  login with your dbdocs credentials

See code: src/commands/login.js

dbdocs logout

logout

USAGE
  $ dbdocs logout

DESCRIPTION
  clears local login credentials

See code: src/commands/logout.js

dbdocs password

set password for your project or remove password

USAGE
  $ dbdocs password

OPTIONS
  -p, --project=project name  project name
  -r, --remove                remove password from your project
  -s, --set=password          password for your project

See code: src/commands/password.js

dbdocs remove [PROJECT_NAME]

remove docs

USAGE
  $ dbdocs remove [PROJECT_NAME]

ARGUMENTS
  PROJECT_NAME  name of the project which you want to remove

See code: src/commands/remove.js