cli-report.md

CLI Report file for "@techdocs/cli"

Do not edit this file. It is a report generated by yarn build:api-reports

techdocs-cli

Usage: techdocs-cli [options] [command]

Options:
  -V, --version
  -h, --help

Commands:
  generate|build [options]
  migrate [options]
  publish [options]
  serve:mkdocs [options]
  serve [options]
  help [command]

techdocs-cli generate

Usage: techdocs-cli generate|build [options]

Options:
  --source-dir <PATH>
  --output-dir <PATH>
  --docker-image <DOCKER_IMAGE>
  --no-pull
  --no-docker
  --techdocs-ref <HOST_TYPE:URL>
  --etag <ETAG>
  --site-name
  -v --verbose
  --omitTechdocsCoreMkdocsPlugin
  --legacyCopyReadmeMdToIndexMd
  -h, --help

techdocs-cli migrate

Usage: techdocs-cli migrate [options]

Options:
  --publisher-type <TYPE>
  --storage-name <BUCKET/CONTAINER NAME>
  --azureAccountName <AZURE ACCOUNT NAME>
  --azureAccountKey <AZURE ACCOUNT KEY>
  --awsRoleArn <AWS ROLE ARN>
  --awsEndpoint <AWS ENDPOINT>
  --awsS3ForcePathStyle
  --osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>
  --osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>
  --osAuthUrl <OPENSTACK SWIFT AUTHURL>
  --osSwiftUrl <OPENSTACK SWIFT SWIFTURL>
  --removeOriginal
  --concurrency <MAX CONCURRENT REQS>
  -v --verbose
  -h, --help

techdocs-cli publish

Usage: techdocs-cli publish [options]

Options:
  --publisher-type <TYPE>
  --storage-name <BUCKET/CONTAINER NAME>
  --entity <NAMESPACE/KIND/NAME>
  --legacyUseCaseSensitiveTripletPaths
  --azureAccountName <AZURE ACCOUNT NAME>
  --azureAccountKey <AZURE ACCOUNT KEY>
  --awsRoleArn <AWS ROLE ARN>
  --awsEndpoint <AWS ENDPOINT>
  --awsProxy <HTTPS Proxy>
  --awsS3sse <AWS SSE>
  --awsS3ForcePathStyle
  --awsBucketRootPath <AWS BUCKET ROOT PATH>
  --osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>
  --osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>
  --osAuthUrl <OPENSTACK SWIFT AUTHURL>
  --osSwiftUrl <OPENSTACK SWIFT SWIFTURL>
  --gcsBucketRootPath <GCS BUCKET ROOT PATH>
  --directory <PATH>
  -h, --help

techdocs-cli serve

Usage: techdocs-cli serve [options]

Options:
  -i, --docker-image <DOCKER_IMAGE>
  --docker-entrypoint <DOCKER_ENTRYPOINT>
  --docker-option <DOCKER_OPTION...>
  --no-docker
  --site-name
  --mkdocs-port <PORT>
  -v --verbose
  --preview-app-bundle-path <PATH_TO_BUNDLE>
  --preview-app-port <PORT>
  -h, --help

techdocs-cli serve:mkdocs

Usage: techdocs-cli serve:mkdocs [options]

Options:
  -i, --docker-image <DOCKER_IMAGE>
  --docker-entrypoint <DOCKER_ENTRYPOINT>
  --docker-option <DOCKER_OPTION...>
  --no-docker
  --site-name
  -p, --port <PORT>
  -v --verbose
  -h, --help