From 0bc7eb1642bfdf799a0b9c9a9c8d5ab4fcd1a179 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Thu, 23 Jun 2022 14:56:38 +0200
Subject: [PATCH] generate API reports for CLI packages

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 packages/cli/cli-report.md          | 425 ++++++++++++++++++++++++++++
 packages/codemods/cli-report.md     |  61 ++++
 packages/create-app/cli-report.md   |  15 +
 packages/e2e-test/cli-report.md     |  26 ++
 packages/techdocs-cli/cli-report.md | 117 ++++++++
 5 files changed, 644 insertions(+)
 create mode 100644 packages/cli/cli-report.md
 create mode 100644 packages/codemods/cli-report.md
 create mode 100644 packages/create-app/cli-report.md
 create mode 100644 packages/e2e-test/cli-report.md
 create mode 100644 packages/techdocs-cli/cli-report.md

diff --git a/packages/cli/cli-report.md b/packages/cli/cli-report.md
new file mode 100644
index 0000000000..04f034cee1
--- /dev/null
+++ b/packages/cli/cli-report.md
@@ -0,0 +1,425 @@
+## CLI Report file for "@backstage/cli"
+
+> Do not edit this file. It is a report generated by `yarn build:api-reports`
+
+### `backstage-cli`
+
+```
+Usage: backstage-cli [options] [command]
+
+Options:
+  -V, --version
+  -h, --help
+
+Commands:
+  create [options]
+  create-plugin [options]
+  plugin:diff [options]
+  test
+  config:docs [options]
+  config:print [options]
+  config:check [options]
+  config:schema [options]
+  repo [command]
+  package [command]
+  migrate [command]
+  versions:bump [options]
+  versions:check [options]
+  clean
+  build-workspace <workspace-dir> [packages...]
+  create-github-app <github-org>
+  info
+  help [command]
+```
+
+### `backstage-cli build-workspace`
+
+```
+Usage: backstage-cli build-workspace [options] <workspace-dir> [packages...]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli clean`
+
+```
+Usage: backstage-cli clean [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli config:check`
+
+```
+Usage: backstage-cli config:check [options]
+
+Options:
+  --package <name>
+  --lax
+  --frontend
+  --deprecated
+  --config <path>
+  -h, --help
+```
+
+### `backstage-cli config:docs`
+
+```
+Usage: backstage-cli config:docs [options]
+
+Options:
+  --package <name>
+  -h, --help
+```
+
+### `backstage-cli config:print`
+
+```
+Usage: backstage-cli config:print [options]
+
+Options:
+  --package <name>
+  --lax
+  --frontend
+  --with-secrets
+  --format <format>
+  --config <path>
+  -h, --help
+```
+
+### `backstage-cli config:schema`
+
+```
+Usage: backstage-cli config:schema [options]
+
+Options:
+  --package <name>
+  --format <format>
+  -h, --help
+```
+
+### `backstage-cli create`
+
+```
+Usage: backstage-cli create [options]
+
+Options:
+  --select <name>
+  --option <name>=<value>
+  --scope <scope>
+  --npm-registry <URL>
+  --no-private
+  -h, --help
+```
+
+### `backstage-cli create-github-app`
+
+```
+Usage: backstage-cli create-github-app [options] <github-org>
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli create-plugin`
+
+```
+Usage: backstage-cli create-plugin [options]
+
+Options:
+  --backend
+  --scope <scope>
+  --npm-registry <URL>
+  --no-private
+  -h, --help
+```
+
+### `backstage-cli info`
+
+```
+Usage: backstage-cli info [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli migrate`
+
+```
+Usage: backstage-cli migrate [options] [command] [command]
+
+Options:
+  -h, --help
+
+Commands:
+  package-roles
+  package-scripts
+  package-lint-configs
+  help [command]
+```
+
+### `backstage-cli migrate package-lint-configs`
+
+```
+Usage: backstage-cli migrate package-lint-configs [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli migrate package-roles`
+
+```
+Usage: backstage-cli migrate package-roles [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli migrate package-scripts`
+
+```
+Usage: backstage-cli migrate package-scripts [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli package`
+
+```
+Usage: backstage-cli package [options] [command] [command]
+
+Options:
+  -h, --help
+
+Commands:
+  start [options]
+  build [options]
+  lint [options] [directories...]
+  test
+  clean
+  prepack
+  postpack
+  help [command]
+```
+
+### `backstage-cli package build`
+
+```
+Usage: backstage-cli package build [options]
+
+Options:
+  --role <name>
+  --minify
+  --experimental-type-build
+  --skip-build-dependencies
+  --stats
+  --config <path>
+  -h, --help
+```
+
+### `backstage-cli package clean`
+
+```
+Usage: backstage-cli package clean [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli package lint`
+
+```
+Usage: backstage-cli package lint [options] [directories...]
+
+Options:
+  --format <format>
+  --fix
+  -h, --help
+```
+
+### `backstage-cli package postpack`
+
+```
+Usage: backstage-cli package postpack [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli package prepack`
+
+```
+Usage: backstage-cli package prepack [options]
+
+Options:
+  -h, --help
+```
+
+### `backstage-cli package start`
+
+```
+Usage: backstage-cli package start [options]
+
+Options:
+  --config <path>
+  --role <name>
+  --check
+  --inspect
+  --inspect-brk
+  -h, --help
+```
+
+### `backstage-cli package test`
+
+```
+Usage: backstage-cli [--config=<pathToConfigFile>] [TestPathPattern]
+
+Options:
+  -h, --help
+  -v, --version
+  --all
+  --automock
+  -b, --bail
+  --cache
+  --cacheDirectory
+  --changedFilesWithAncestor
+  --changedSince
+  --ci
+  --clearCache
+  --clearMocks
+  --collectCoverage
+  --collectCoverageFrom
+  --collectCoverageOnlyFrom
+  --color
+  --colors
+  -c, --config
+  --coverage
+  --coverageDirectory
+  --coveragePathIgnorePatterns
+  --coverageProvider
+  --coverageReporters
+  --coverageThreshold
+  --debug
+  --detectLeaks
+  --detectOpenHandles
+  --env
+  --errorOnDeprecated
+  -e, --expand
+  --filter
+  --findRelatedTests
+  --forceExit
+```
+
+### `backstage-cli plugin:diff`
+
+```
+Usage: backstage-cli plugin:diff [options]
+
+Options:
+  --check
+  --yes
+  -h, --help
+```
+
+### `backstage-cli repo`
+
+```
+Usage: backstage-cli repo [options] [command] [command]
+
+Options:
+  -h, --help
+
+Commands:
+  build [options]
+  lint [options]
+  help [command]
+```
+
+### `backstage-cli repo build`
+
+```
+Usage: backstage-cli repo build [options]
+
+Options:
+  --all
+  --since <ref>
+  -h, --help
+```
+
+### `backstage-cli repo lint`
+
+```
+Usage: backstage-cli repo lint [options]
+
+Options:
+  --format <format>
+  --since <ref>
+  --fix
+  -h, --help
+```
+
+### `backstage-cli test`
+
+```
+Usage: backstage-cli [--config=<pathToConfigFile>] [TestPathPattern]
+
+Options:
+  -h, --help
+  -v, --version
+  --all
+  --automock
+  -b, --bail
+  --cache
+  --cacheDirectory
+  --changedFilesWithAncestor
+  --changedSince
+  --ci
+  --clearCache
+  --clearMocks
+  --collectCoverage
+  --collectCoverageFrom
+  --collectCoverageOnlyFrom
+  --color
+  --colors
+  -c, --config
+  --coverage
+  --coverageDirectory
+  --coveragePathIgnorePatterns
+  --coverageProvider
+  --coverageReporters
+  --coverageThreshold
+  --debug
+  --detectLeaks
+  --detectOpenHandles
+  --env
+  --errorOnDeprecated
+  -e, --expand
+  --filter
+  --findRelatedTests
+  --forceExit
+```
+
+### `backstage-cli versions:bump`
+
+```
+Usage: backstage-cli versions:bump [options]
+
+Options:
+  --pattern <glob>
+  --release <version|next|main>
+  -h, --help
+```
+
+### `backstage-cli versions:check`
+
+```
+Usage: backstage-cli versions:check [options]
+
+Options:
+  --fix
+  -h, --help
+```
diff --git a/packages/codemods/cli-report.md b/packages/codemods/cli-report.md
new file mode 100644
index 0000000000..57d2198141
--- /dev/null
+++ b/packages/codemods/cli-report.md
@@ -0,0 +1,61 @@
+## CLI Report file for "@backstage/codemods"
+
+> Do not edit this file. It is a report generated by `yarn build:api-reports`
+
+### `backstage-codemods`
+
+```
+Usage: backstage-codemods [options] [command]
+
+Options:
+  -V, --version
+  -h, --help
+
+Commands:
+  apply <codemod> [target-dirs...]
+  list
+  help [command]
+```
+
+### `backstage-codemods apply`
+
+```
+Usage: backstage-codemods apply [options] [command] <codemod> [target-dirs...]
+
+Options:
+  -h, --help
+
+Commands:
+  core-imports [options] [target-dirs...]
+  extension-names [options] [target-dirs...]
+  help [command]
+```
+
+### `backstage-codemods apply core-imports`
+
+```
+Usage: backstage-codemods apply core-imports [options] [target-dirs...]
+
+Options:
+  -d, --dry
+  -h, --help
+```
+
+### `backstage-codemods apply extension-names`
+
+```
+Usage: backstage-codemods apply extension-names [options] [target-dirs...]
+
+Options:
+  -d, --dry
+  -h, --help
+```
+
+### `backstage-codemods list`
+
+```
+Usage: backstage-codemods list [options]
+
+Options:
+  -h, --help
+```
diff --git a/packages/create-app/cli-report.md b/packages/create-app/cli-report.md
new file mode 100644
index 0000000000..1244432c6a
--- /dev/null
+++ b/packages/create-app/cli-report.md
@@ -0,0 +1,15 @@
+## CLI Report file for "@backstage/create-app"
+
+> Do not edit this file. It is a report generated by `yarn build:api-reports`
+
+### `backstage-create-app`
+
+```
+Usage: backstage-create-app [options]
+
+Options:
+  -V, --version
+  --path [directory]
+  --skip-install
+  -h, --help
+```
diff --git a/packages/e2e-test/cli-report.md b/packages/e2e-test/cli-report.md
new file mode 100644
index 0000000000..3a3912b8fc
--- /dev/null
+++ b/packages/e2e-test/cli-report.md
@@ -0,0 +1,26 @@
+## CLI Report file for "e2e-test"
+
+> Do not edit this file. It is a report generated by `yarn build:api-reports`
+
+### `e2e-test`
+
+```
+Usage: e2e-test [options] [command]
+
+Options:
+  -V, --version
+  -h, --help
+
+Commands:
+  run
+  help [command]
+```
+
+### `e2e-test run`
+
+```
+Usage: e2e-test run [options]
+
+Options:
+  -h, --help
+```
diff --git a/packages/techdocs-cli/cli-report.md b/packages/techdocs-cli/cli-report.md
new file mode 100644
index 0000000000..64b5e9c090
--- /dev/null
+++ b/packages/techdocs-cli/cli-report.md
@@ -0,0 +1,117 @@
+## 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>
+  -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
+  --awsBucketRootPath
+  --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>
+  --awsS3sse <AWS SSE>
+  --awsS3ForcePathStyle
+  --osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>
+  --osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>
+  --osAuthUrl <OPENSTACK SWIFT AUTHURL>
+  --osSwiftUrl <OPENSTACK SWIFT SWIFTURL>
+  --gcsBucketRootPath
+  --directory <PATH>
+  -h, --help
+```
+
+### `techdocs-cli serve`
+
+```
+Usage: techdocs-cli serve [options]
+
+Options:
+  -i, --docker-image <DOCKER_IMAGE>
+  --docker-entrypoint <DOCKER_ENTRYPOINT>
+  --no-docker
+  --mkdocs-port <PORT>
+  -v --verbose
+  -h, --help
+```
+
+### `techdocs-cli serve:mkdocs`
+
+```
+Usage: techdocs-cli serve:mkdocs [options]
+
+Options:
+  -i, --docker-image <DOCKER_IMAGE>
+  --docker-entrypoint <DOCKER_ENTRYPOINT>
+  --no-docker
+  -p, --port <PORT>
+  -v --verbose
+  -h, --help
+```