dbdocs-aml v0.6.9

dbdocs

• Usage
• Commands

Usage

$ npm install -g dbdocs
$ dbdocs COMMAND
running command...
$ dbdocs (-v|--version|version)
dbdocs/0.6.2 darwin-x64 node-v15.10.0
$ dbdocs --help [COMMAND]
USAGE
  $ dbdocs COMMAND
...

Commands

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

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

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

dbdocs login

login to dbdocs

USAGE
  $ dbdocs login

DESCRIPTION
  login with your dbdocs credentials

dbdocs logout

logout

USAGE
  $ dbdocs logout

DESCRIPTION
  clears local login credentials

dbdocs ls

list projects

USAGE
  $ dbdocs ls

DESCRIPTION
  list all projects in your default organization

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

dbdocs remove [PROJECT_NAME]

remove docs

USAGE
  $ dbdocs remove [PROJECT_NAME]

ARGUMENTS
  PROJECT_NAME  name of the project which you want to remove

dbdocs token

generate or revoke your authentication token

USAGE
  $ dbdocs token

OPTIONS
  -g, --generate  generate authentication token
  -r, --revoke    revoke authentication token

dbdocs validate [FILEPATH]

validate docs content

USAGE
  $ dbdocs validate [FILEPATH]

ARGUMENTS
  FILEPATH  dbml file path