diff --git a/doc.py b/doc.py index 7cf06e1b..f22a4589 100755 --- a/doc.py +++ b/doc.py @@ -7,6 +7,7 @@ import os import re import sys +import textwrap from collections import defaultdict from functools import reduce from pathlib import Path @@ -442,6 +443,7 @@ def _process_description(argument: SerializedArgument) -> str: def str_plain(string: str) -> str: + string = textwrap.dedent(string) bold = re.escape(cli.Colors.BOLD.value) blue = re.escape(cli.Colors.BRIGHT_BLUE.value) reset = re.escape(cli.Colors.RESET.value) diff --git a/docs/README.md b/docs/README.md index 593a1943..7b33927e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ CLI tools |Tool name|Description| | :--- | :--- | -|[`android-app-bundle`](android-app-bundle/README.md)|Manage Android App Bundles using [Bundletool](https://developer.android.com/studio/command-line/bundletool)| +|[`android-app-bundle`](android-app-bundle/README.md)|Manage Android App Bundles using [Bundletool](https://developer.android.com/studio/command-line/bundletool)| |[`android-keystore`](android-keystore/README.md)|Manage your Android app code signing keystores| |[`app-store-connect`](app-store-connect/README.md)|Interact with Apple services via App Store Connect API| |[`codemagic-cli-tools`](codemagic-cli-tools/README.md)|Show general information of installed Codemagic CLI tools| @@ -12,5 +12,5 @@ CLI tools |[`git-changelog`](git-changelog/README.md)|Generate a changelog text from git history| |[`google-play`](google-play/README.md)|Utility to get the latest build numbers from Google Play using Google Play Developer API| |[`keychain`](keychain/README.md)|Utility to manage macOS keychains and certificates| -|[`universal-apk`](universal-apk/README.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead| -|[`xcode-project`](xcode-project/README.md)|Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests| +|[`universal-apk`](universal-apk/README.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead| +|[`xcode-project`](xcode-project/README.md)|Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests| diff --git a/docs/android-app-bundle/README.md b/docs/android-app-bundle/README.md index 19b71bfc..4b3d9504 100644 --- a/docs/android-app-bundle/README.md +++ b/docs/android-app-bundle/README.md @@ -3,7 +3,7 @@ android-app-bundle ================== -**Manage Android App Bundles using [Bundletool](https://developer.android.com/studio/command-line/bundletool)** +**Manage Android App Bundles using [Bundletool](https://developer.android.com/studio/command-line/bundletool)** ### Usage ```bash android-app-bundle [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] @@ -39,7 +39,7 @@ Enable verbose logging for commands |Action|Description| | :--- | :--- | -|[`build-apks`](build-apks.md)|Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives| +|[`build-apks`](build-apks.md)|Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives| |[`build-universal-apk`](build-universal-apk.md)|Shortcut for `build-apks` to build universal APKs from bundles| |[`bundletool-version`](bundletool-version.md)|Get Bundletool version| |[`dump`](dump.md)|Get files list or extract values from the bundle in a human-readable form| diff --git a/docs/android-app-bundle/build-apks.md b/docs/android-app-bundle/build-apks.md index cc0c2984..19809961 100644 --- a/docs/android-app-bundle/build-apks.md +++ b/docs/android-app-bundle/build-apks.md @@ -3,7 +3,7 @@ build-apks ========== -**Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives** +**Generates an APK Set archive containing either all possible split APKs and standalone APKs or APKs optimized for the connected device (see connected- device flag). Returns list of generated APK set archives** ### Usage ```bash android-app-bundle build-apks [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/android-keystore/README.md b/docs/android-keystore/README.md index 4d15b8b6..19fd6dfe 100644 --- a/docs/android-keystore/README.md +++ b/docs/android-keystore/README.md @@ -43,4 +43,4 @@ Enable verbose logging for commands |[`create-debug-keystore`](create-debug-keystore.md)|Create Android debug keystore at ~/.android/debug.keystore| |[`certificate`](certificate.md)|Extract certificate for specified alias from the keystore| |[`certificates`](certificates.md)|List certificates that are included in keystore| -|[`verify`](verify.md)|Check that the keystore password, key password and key alias are correct for specified keystore| +|[`verify`](verify.md)|Check that the keystore password, key password and key alias are correct for specified keystore| diff --git a/docs/android-keystore/verify.md b/docs/android-keystore/verify.md index 93c5899f..4340d55b 100644 --- a/docs/android-keystore/verify.md +++ b/docs/android-keystore/verify.md @@ -3,7 +3,7 @@ verify ====== -**Check that the keystore password, key password and key alias are correct for specified keystore** +**Check that the keystore password, key password and key alias are correct for specified keystore** ### Usage ```bash android-keystore verify [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/README.md b/docs/app-store-connect/README.md index 685726cb..ff1567af 100644 --- a/docs/app-store-connect/README.md +++ b/docs/app-store-connect/README.md @@ -97,7 +97,7 @@ Enable verbose logging for commands |[`delete-bundle-id`](delete-bundle-id.md)|Delete specified Bundle ID from Apple Developer portal| |[`delete-certificate`](delete-certificate.md)|Delete specified Signing Certificate from Apple Developer portal| |[`delete-profile`](delete-profile.md)|Delete specified Profile from Apple Developer portal| -|[`fetch-signing-files`](fetch-signing-files.md)|Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier| +|[`fetch-signing-files`](fetch-signing-files.md)|Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier| |[`get-bundle-id`](get-bundle-id.md)|Get specified Bundle ID from Apple Developer portal| |[`get-certificate`](get-certificate.md)|Get specified Signing Certificate from Apple Developer portal| |[`get-latest-app-store-build-number`](get-latest-app-store-build-number.md)|Get the latest App Store build number of the highest version for the given application| diff --git a/docs/app-store-connect/app-store-version-localizations.md b/docs/app-store-connect/app-store-version-localizations.md index a7f54de2..1537a2e9 100644 --- a/docs/app-store-connect/app-store-version-localizations.md +++ b/docs/app-store-connect/app-store-version-localizations.md @@ -91,7 +91,7 @@ Enable verbose logging for commands |Action|Description| | :--- | :--- | -|[`create`](app-store-version-localizations/create.md)|Create an App Store Version Localization. Add localized version-level information for a new locale.| -|[`delete`](app-store-version-localizations/delete.md)|Delete an App Store Version Localization. Remove a language from your version metadata.| -|[`get`](app-store-version-localizations/get.md)|Read App Store Version Localization Information. Get localized version-level information.| -|[`modify`](app-store-version-localizations/modify.md)|Modify an App Store Version Localization. Edit localized version-level information for a particular language.| +|[`create`](app-store-version-localizations/create.md)|Create an App Store Version Localization. Add localized version-level information for a new locale.| +|[`delete`](app-store-version-localizations/delete.md)|Delete an App Store Version Localization. Remove a language from your version metadata.| +|[`get`](app-store-version-localizations/get.md)|Read App Store Version Localization Information. Get localized version-level information.| +|[`modify`](app-store-version-localizations/modify.md)|Modify an App Store Version Localization. Edit localized version-level information for a particular language.| diff --git a/docs/app-store-connect/app-store-version-localizations/create.md b/docs/app-store-connect/app-store-version-localizations/create.md index d5b83b8b..2c833733 100644 --- a/docs/app-store-connect/app-store-version-localizations/create.md +++ b/docs/app-store-connect/app-store-version-localizations/create.md @@ -3,7 +3,7 @@ create ====== -**Create an App Store Version Localization. Add localized version-level information for a new locale.** +**Create an App Store Version Localization. Add localized version-level information for a new locale.** ### Usage ```bash app-store-connect app-store-version-localizations create [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/app-store-version-localizations/delete.md b/docs/app-store-connect/app-store-version-localizations/delete.md index d27a8c8c..7509d031 100644 --- a/docs/app-store-connect/app-store-version-localizations/delete.md +++ b/docs/app-store-connect/app-store-version-localizations/delete.md @@ -3,7 +3,7 @@ delete ====== -**Delete an App Store Version Localization. Remove a language from your version metadata.** +**Delete an App Store Version Localization. Remove a language from your version metadata.** ### Usage ```bash app-store-connect app-store-version-localizations delete [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/app-store-version-localizations/get.md b/docs/app-store-connect/app-store-version-localizations/get.md index fd0c0a97..f025c7ec 100644 --- a/docs/app-store-connect/app-store-version-localizations/get.md +++ b/docs/app-store-connect/app-store-version-localizations/get.md @@ -3,7 +3,7 @@ get === -**Read App Store Version Localization Information. Get localized version-level information.** +**Read App Store Version Localization Information. Get localized version-level information.** ### Usage ```bash app-store-connect app-store-version-localizations get [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/app-store-version-localizations/modify.md b/docs/app-store-connect/app-store-version-localizations/modify.md index eaecb198..41b4aa5d 100644 --- a/docs/app-store-connect/app-store-version-localizations/modify.md +++ b/docs/app-store-connect/app-store-version-localizations/modify.md @@ -3,7 +3,7 @@ modify ====== -**Modify an App Store Version Localization. Edit localized version-level information for a particular language.** +**Modify an App Store Version Localization. Edit localized version-level information for a particular language.** ### Usage ```bash app-store-connect app-store-version-localizations modify [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/app-store-versions.md b/docs/app-store-connect/app-store-versions.md index 87d6f884..d189c3dc 100644 --- a/docs/app-store-connect/app-store-versions.md +++ b/docs/app-store-connect/app-store-versions.md @@ -93,5 +93,5 @@ Enable verbose logging for commands | :--- | :--- | |[`create`](app-store-versions/create.md)|Add a new App Store version to an app using specified build.| |[`delete`](app-store-versions/delete.md)|Delete specified App Store version from Apple Developer portal| -|[`localizations`](app-store-versions/localizations.md)|List All App Store Version Localizations for an App Store Version. Get a list of localized, version-level information about an app, for all locales.| +|[`localizations`](app-store-versions/localizations.md)|List All App Store Version Localizations for an App Store Version. Get a list of localized, version-level information about an app, for all locales.| |[`modify`](app-store-versions/modify.md)|Update the app store version for a specific app.| diff --git a/docs/app-store-connect/app-store-versions/localizations.md b/docs/app-store-connect/app-store-versions/localizations.md index 5d5ce420..5b7a75c1 100644 --- a/docs/app-store-connect/app-store-versions/localizations.md +++ b/docs/app-store-connect/app-store-versions/localizations.md @@ -3,7 +3,7 @@ localizations ============= -**List All App Store Version Localizations for an App Store Version. Get a list of localized, version-level information about an app, for all locales.** +**List All App Store Version Localizations for an App Store Version. Get a list of localized, version-level information about an app, for all locales.** ### Usage ```bash app-store-connect app-store-versions localizations [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/beta-build-localizations.md b/docs/app-store-connect/beta-build-localizations.md index b90f54e7..ea4045f9 100644 --- a/docs/app-store-connect/beta-build-localizations.md +++ b/docs/app-store-connect/beta-build-localizations.md @@ -91,7 +91,7 @@ Enable verbose logging for commands |Action|Description| | :--- | :--- | -|[`create`](beta-build-localizations/create.md)|Create a beta build localization if it doesn't exist or update existing beta build localization for specified locale| +|[`create`](beta-build-localizations/create.md)|Create a beta build localization if it doesn't exist or update existing beta build localization for specified locale| |[`delete`](beta-build-localizations/delete.md)|Delete a beta build localization| |[`get`](beta-build-localizations/get.md)|Get beta build localization| |[`list`](beta-build-localizations/list.md)|List beta build localizations| diff --git a/docs/app-store-connect/beta-build-localizations/create.md b/docs/app-store-connect/beta-build-localizations/create.md index 66e5b64f..3595e603 100644 --- a/docs/app-store-connect/beta-build-localizations/create.md +++ b/docs/app-store-connect/beta-build-localizations/create.md @@ -3,7 +3,7 @@ create ====== -**Create a beta build localization if it doesn't exist or update existing beta build localization for specified locale** +**Create a beta build localization if it doesn't exist or update existing beta build localization for specified locale** ### Usage ```bash app-store-connect beta-build-localizations create [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/app-store-connect/fetch-signing-files.md b/docs/app-store-connect/fetch-signing-files.md index d1bbcfd0..a49221f3 100644 --- a/docs/app-store-connect/fetch-signing-files.md +++ b/docs/app-store-connect/fetch-signing-files.md @@ -3,7 +3,7 @@ fetch-signing-files =================== -**Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier** +**Fetch provisioning profiles and code signing certificates for Bundle ID with given identifier** ### Usage ```bash app-store-connect fetch-signing-files [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/google-play/tracks.md b/docs/google-play/tracks.md index 3f2b7887..47eee723 100644 --- a/docs/google-play/tracks.md +++ b/docs/google-play/tracks.md @@ -48,4 +48,4 @@ Enable verbose logging for commands | :--- | :--- | |[`get`](tracks/get.md)|Get information about specified track from Google Play Developer API| |[`list`](tracks/list.md)|Get information about specified track from Google Play Developer API| -|[`promote-release`](tracks/promote-release.md)|Promote releases from source track to target track. If filters for source track release are not specified, then the latest release will be promoted| +|[`promote-release`](tracks/promote-release.md)|Promote releases from source track to target track. If filters for source track release are not specified, then the latest release will be promoted| diff --git a/docs/google-play/tracks/promote-release.md b/docs/google-play/tracks/promote-release.md index 3b8f3417..7cc4d8cb 100644 --- a/docs/google-play/tracks/promote-release.md +++ b/docs/google-play/tracks/promote-release.md @@ -3,7 +3,7 @@ promote-release =============== -**Promote releases from source track to target track. If filters for source track release are not specified, then the latest release will be promoted** +**Promote releases from source track to target track. If filters for source track release are not specified, then the latest release will be promoted** ### Usage ```bash google-play tracks promote-release [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/README.md b/docs/keychain/README.md index 4610ed19..436870cf 100644 --- a/docs/keychain/README.md +++ b/docs/keychain/README.md @@ -50,11 +50,11 @@ Enable verbose logging for commands |[`create`](create.md)|Create a macOS keychain, add it to the search list| |[`delete`](delete.md)|Delete keychains and remove them from the search list| |[`get-default`](get-default.md)|Show the system default keychain| -|[`initialize`](initialize.md)|Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use| +|[`initialize`](initialize.md)|Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use| |[`list-certificates`](list-certificates.md)|List available code signing certificates in specified keychain| |[`lock`](lock.md)|Lock the specified keychain| |[`make-default`](make-default.md)|Set the keychain as the system default keychain| -|[`set-timeout`](set-timeout.md)|Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set| +|[`set-timeout`](set-timeout.md)|Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set| |[`show-info`](show-info.md)|Show all settings for the keychain| |[`unlock`](unlock.md)|Unlock the specified keychain| |[`use-login`](use-login.md)|Use login keychain as the default keychain| diff --git a/docs/keychain/initialize.md b/docs/keychain/initialize.md index 5cb47fc4..7b9b43d9 100644 --- a/docs/keychain/initialize.md +++ b/docs/keychain/initialize.md @@ -3,7 +3,7 @@ initialize ========== -**Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use** +**Set up the keychain to be used for code signing. Create the keychain at specified path with specified password with given timeout. Make it default and unlock it for upcoming use** ### Usage ```bash keychain initialize [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/keychain/set-timeout.md b/docs/keychain/set-timeout.md index 1227e0e2..357c8c66 100644 --- a/docs/keychain/set-timeout.md +++ b/docs/keychain/set-timeout.md @@ -3,7 +3,7 @@ set-timeout =========== -**Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set** +**Set timeout settings for the keychain. If seconds are not provided, then no-timeout will be set** ### Usage ```bash keychain set-timeout [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/universal-apk/README.md b/docs/universal-apk/README.md index 646880b0..9953c3f6 100644 --- a/docs/universal-apk/README.md +++ b/docs/universal-apk/README.md @@ -3,7 +3,7 @@ universal-apk ============= -**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead** +**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle` instead** ### Usage ```bash universal-apk [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] @@ -66,4 +66,4 @@ Enable verbose logging for commands |Action|Description| | :--- | :--- | -|[`generate`](generate.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead| +|[`generate`](generate.md)|Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead| diff --git a/docs/universal-apk/generate.md b/docs/universal-apk/generate.md index 9fa994f7..9802301f 100644 --- a/docs/universal-apk/generate.md +++ b/docs/universal-apk/generate.md @@ -3,7 +3,7 @@ generate ======== -**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead** +**Generate universal APK files from Android App Bundles. DEPRECATED! Use `android-app-bundle build-universal-apk` instead** ### Usage ```bash universal-apk generate [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] diff --git a/docs/xcode-project/README.md b/docs/xcode-project/README.md index f59b7dac..1c0dfa4b 100644 --- a/docs/xcode-project/README.md +++ b/docs/xcode-project/README.md @@ -3,7 +3,7 @@ xcode-project ============= -**Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests** +**Utility to work with Xcode projects. Use it to manage iOS application code signing properties for builds, create IPAs and run tests** ### Usage ```bash xcode-project [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v] @@ -50,4 +50,4 @@ Enable verbose logging for commands |[`run-tests`](run-tests.md)|Run unit or UI tests for given Xcode project or workspace| |[`show-build-settings`](show-build-settings.md)|Show build settings for Xcode project| |[`test-summary`](test-summary.md)|Show summary of Xcode Test Result| -|[`use-profiles`](use-profiles.md)|Set up code signing settings on specified Xcode projects to use given provisioning profiles| +|[`use-profiles`](use-profiles.md)|Set up code signing settings on specified Xcode projects to use given provisioning profiles| diff --git a/docs/xcode-project/use-profiles.md b/docs/xcode-project/use-profiles.md index dcd943cb..47ebfe5b 100644 --- a/docs/xcode-project/use-profiles.md +++ b/docs/xcode-project/use-profiles.md @@ -3,7 +3,7 @@ use-profiles ============ -**Set up code signing settings on specified Xcode projects to use given provisioning profiles** +**Set up code signing settings on specified Xcode projects to use given provisioning profiles** ### Usage ```bash xcode-project use-profiles [-h] [--log-stream STREAM] [--no-color] [--version] [-s] [-v]