UNPKG

@appzung/cli

Version:

AppZung CLI

715 lines (533 loc) 23.9 kB
@appzung/cli ================= AppZung CLI [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![Version](https://img.shields.io/npm/v/@appzung/cli.svg)](https://npmjs.org/package/@appzung/cli) [![Downloads/week](https://img.shields.io/npm/dw/@appzung/cli.svg)](https://npmjs.org/package/@appzung/cli) <!-- toc --> * [Usage](#usage) * [Commands](#commands) <!-- tocstop --> # Usage <!-- usage --> ```sh-session $ npm install -g @appzung/cli $ appzung COMMAND running command... $ appzung (--version) @appzung/cli/1.5.2 linux-x64 node-v22.14.0 $ appzung --help [COMMAND] USAGE $ appzung COMMAND ... ``` <!-- usagestop --> # Commands <!-- commands --> * [`appzung applications create`](#appzung-applications-create) * [`appzung applications edit`](#appzung-applications-edit) * [`appzung applications list`](#appzung-applications-list) * [`appzung auth login`](#appzung-auth-login) * [`appzung auth logout`](#appzung-auth-logout) * [`appzung auth whoami`](#appzung-auth-whoami) * [`appzung autocomplete [SHELL]`](#appzung-autocomplete-shell) * [`appzung billing manage`](#appzung-billing-manage) * [`appzung billing subscribe`](#appzung-billing-subscribe) * [`appzung codepush migrate`](#appzung-codepush-migrate) * [`appzung help [COMMAND]`](#appzung-help-command) * [`appzung organizations create`](#appzung-organizations-create) * [`appzung organizations list`](#appzung-organizations-list) * [`appzung projects api-keys create`](#appzung-projects-api-keys-create) * [`appzung projects api-keys revoke`](#appzung-projects-api-keys-revoke) * [`appzung projects create`](#appzung-projects-create) * [`appzung projects edit`](#appzung-projects-edit) * [`appzung projects list`](#appzung-projects-list) * [`appzung release-channels create`](#appzung-release-channels-create) * [`appzung release-channels edit`](#appzung-release-channels-edit) * [`appzung release-channels list`](#appzung-release-channels-list) * [`appzung releases deploy`](#appzung-releases-deploy) * [`appzung releases deploy-react-native`](#appzung-releases-deploy-react-native) * [`appzung releases edit`](#appzung-releases-edit) * [`appzung releases list`](#appzung-releases-list) * [`appzung releases promote`](#appzung-releases-promote) * [`appzung releases rollback`](#appzung-releases-rollback) * [`appzung releases show`](#appzung-releases-show) * [`appzung version`](#appzung-version) * [`appzung welcome`](#appzung-welcome) ## `appzung applications create` Create a new application ``` USAGE $ appzung applications create [-o <value>] [-p <value>] [-n <value>] [--platform android|ios|macos|other|tvos|windows] [-y] FLAGS -y, --yes Skip confirmation prompt REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -n, --name=<value> Application name -o, --org=<value> Organization slug -p, --project=<value> Project slug --platform=<option> Application platform <options: android|ios|macos|other|tvos|windows> DESCRIPTION Create a new application ``` ## `appzung applications edit` Edit an application ``` USAGE $ appzung applications edit [-o <value>] [-p <value>] [-a <value>] [--name <value>] [--platform android|ios|macos|other|tvos|windows] FLAGS --name=<value> New application name --platform=<option> New application platform <options: android|ios|macos|other|tvos|windows> REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -a, --app=<value> Application slug -o, --org=<value> Organization slug -p, --project=<value> Project slug DESCRIPTION Edit an application ``` ## `appzung applications list` List applications in a project ``` USAGE $ appzung applications list [-o <value>] [-p <value>] [--page <value>] FLAGS --page=<value> Page REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -o, --org=<value> Organization slug -p, --project=<value> Project slug DESCRIPTION List applications in a project ``` ## `appzung auth login` Open login page and retrieve token ``` USAGE $ appzung auth login [-m] FLAGS -m, --manual Skip automatic token listening and use manual token entry DESCRIPTION Open login page and retrieve token ``` ## `appzung auth logout` Logout from the current session ``` USAGE $ appzung auth logout DESCRIPTION Logout from the current session ``` ## `appzung auth whoami` Show currently logged in user ``` USAGE $ appzung auth whoami DESCRIPTION Show currently logged in user ``` ## `appzung autocomplete [SHELL]` Display autocomplete installation instructions. ``` USAGE $ appzung autocomplete [SHELL] [-r] ARGUMENTS SHELL (zsh|bash|powershell) Shell type FLAGS -r, --refresh-cache Refresh cache (ignores displaying instructions) DESCRIPTION Display autocomplete installation instructions. EXAMPLES $ appzung autocomplete $ appzung autocomplete bash $ appzung autocomplete zsh $ appzung autocomplete powershell $ appzung autocomplete --refresh-cache ``` _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.17/src/commands/autocomplete/index.ts)_ ## `appzung billing manage` Manage your subscription and billing info ``` USAGE $ appzung billing manage DESCRIPTION Manage your subscription and billing info ``` ## `appzung billing subscribe` Subscribe to a plan ``` USAGE $ appzung billing subscribe DESCRIPTION Subscribe to a plan ``` ## `appzung codepush migrate` Migrate data from AppCenter ``` USAGE $ appzung codepush migrate [-h] [--appcenter-api-token <value>] FLAGS -h, --help Show CLI help. --appcenter-api-token=<value> AppCenter API Token (create one at https://appcenter.ms/settings/apitokens) DESCRIPTION Migrate data from AppCenter ``` ## `appzung help [COMMAND]` Display help for appzung. ``` USAGE $ appzung help [COMMAND...] [-n] ARGUMENTS COMMAND... Command to show help for. FLAGS -n, --nested-commands Include all nested commands in the output. DESCRIPTION Display help for appzung. ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.20/src/commands/help.ts)_ ## `appzung organizations create` Create a new organization ``` USAGE $ appzung organizations create [-n <value>] [-e <value>] [-y] FLAGS -y, --yes Skip confirmation prompt REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -e, --email=<value> Organization email -n, --name=<value> Organization name DESCRIPTION Create a new organization ``` ## `appzung organizations list` List your organizations ``` USAGE $ appzung organizations list [--page <value>] FLAGS --page=<value> Page DESCRIPTION List your organizations ``` ## `appzung projects api-keys create` Create a new API key for a project ``` USAGE $ appzung projects api-keys create [-o <value>] [-p <value>] [-n <value>] FLAGS -n, --name=<value> API key name REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -o, --org=<value> Organization slug -p, --project=<value> Project slug DESCRIPTION Create a new API key for a project ``` ## `appzung projects api-keys revoke` Revoke all API keys for a project ``` USAGE $ appzung projects api-keys revoke [-o <value>] [-p <value>] REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -o, --org=<value> Organization slug -p, --project=<value> Project slug DESCRIPTION Revoke all API keys for a project ``` ## `appzung projects create` Create a new project ``` USAGE $ appzung projects create [-o <value>] [-n <value>] [--framework CAPACITOR|CORDOVA|ELECTRON|NATIVE|OTHER|REACT_NATIVE|UNITY|XAMARIN] [--releaseType Alpha|Beta|Canary|Demo|Development|Local|Preview|Production|QA|Sandbox|Staging] [-y] FLAGS -y, --yes Skip confirmation prompt REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -n, --name=<value> Project name -o, --org=<value> Organization slug --framework=<option> Project framework <options: CAPACITOR|CORDOVA|ELECTRON|NATIVE|OTHER|REACT_NATIVE|UNITY|XAMARIN> --releaseType=<option> Release type (this has no real impact but helps organize projects) <options: Alpha|Beta|Canary|Demo|Development|Local|Preview|Production|QA|Sandbox|Staging> DESCRIPTION Create a new project ``` ## `appzung projects edit` Edit a project ``` USAGE $ appzung projects edit [-o <value>] [-p <value>] [--name <value>] [--framework CAPACITOR|CORDOVA|ELECTRON|NATIVE|OTHER|REACT_NATIVE|UNITY|XAMARIN] [--releaseType Alpha|Beta|Canary|Demo|Development|Local|Preview|Production|QA|Sandbox|Staging] FLAGS --framework=<option> New project framework <options: CAPACITOR|CORDOVA|ELECTRON|NATIVE|OTHER|REACT_NATIVE|UNITY|XAMARIN> --name=<value> New project name --releaseType=<option> New release type <options: Alpha|Beta|Canary|Demo|Development|Local|Preview|Production|QA|Sandbox|Staging> REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -o, --org=<value> Organization slug -p, --project=<value> Project slug DESCRIPTION Edit a project ``` ## `appzung projects list` List projects in an organization ``` USAGE $ appzung projects list [-o <value>] [--page <value>] FLAGS --page=<value> Page REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -o, --org=<value> Organization slug DESCRIPTION List projects in an organization ``` ## `appzung release-channels create` Create a new release channel ``` USAGE $ appzung release-channels create [-o <value>] [-p <value>] [-a <value>] [-n <value>] [-y] FLAGS -y, --yes Skip confirmation prompt REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -a, --app=<value> Application slug -n, --name=<value> Release channel name -o, --org=<value> Organization slug -p, --project=<value> Project slug DESCRIPTION Create a new release channel ``` ## `appzung release-channels edit` Edit a release channel ``` USAGE $ appzung release-channels edit [--release-channel <value>] [--name <value>] FLAGS --name=<value> New release channel name REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS --release-channel=<value> Release channel ID DESCRIPTION Edit a release channel ``` ## `appzung release-channels list` List release channels in an application ``` USAGE $ appzung release-channels list [-o <value>] [-p <value>] [-a <value>] [--page <value>] FLAGS --page=<value> Page REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS -a, --app=<value> Application slug -o, --org=<value> Organization slug -p, --project=<value> Project slug DESCRIPTION List release channels in an application ``` ## `appzung releases deploy` Deploy a generic release ``` USAGE $ appzung releases deploy -t <value> -c <value> [-h] [--release-channel <value>] [-r <value>] [-m] [-x] [--disable-duplicate-release-error] [-k <value>] [--description <value>] [--description-from-current-git-commit] [-s <value>] FLAGS -c, --update-contents-path=<value> (required) Path to release contents folder -h, --help Show CLI help. -k, --private-key-path=<value> Specifies the location of a RSA private key to sign the release with. -m, --[no-]mandatory Specifies whether this release should be considered mandatory -r, --rollout=<value> Percentage points of users this release should be available to (eg. 95 for 95%) -t, --target-binary-version=<value> (required) Semver version that specifies the binary app version this release is compatible with -x, --[no-]disabled Specifies whether this release should not be immediately downloadable --description=<value> Description of the changes made to the app in this release --description-from-current-git-commit Use the current git commit message as the release description (truncated at 255 characters). --description takes precedence. --disable-duplicate-release-error When this flag is set, releasing a package that is identical to the latest release will produce a warning instead of an error --release-channel=<value> Release channel (eg. "myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e") AUTHENTICATION FLAGS -s, --api-key=<value> An API key that has access to this project. If there is a user logged in, the API key will take precedence. DESCRIPTION Deploy a generic release ``` ## `appzung releases deploy-react-native` Deploy a React Native release ``` USAGE $ appzung releases deploy-react-native [-h] [--release-channel <value>] [-r <value>] [-m] [-x] [--disable-duplicate-release-error] [-k <value>] [--description <value>] [--description-from-current-git-commit] [-s <value>] [-t <value>] [-b <value>] [--development] [--use-hermes] [--use-jsc] [--extra-hermes-flag <value>...] [--extra-bundler-option <value>...] [-e <value>] [-s <value>] [-o <value>] [--react-native-cli-path <value>] [--sentry-sourcemap-debug-id --sourcemap-output-dir <value>] [-g <value>] [--pod-file <value>] [-p <value>] [--xcode-project-file <value>] [--plist-file-prefix <value>] [-c <value>] [--xcode-target-name <value>] [-y] FLAGS -h, --help Show CLI help. -k, --private-key-path=<value> Specifies the location of a RSA private key to sign the release with. -m, --[no-]mandatory Specifies whether this release should be considered mandatory -r, --rollout=<value> Percentage points of users this release should be available to (eg. 95 for 95%) -t, --target-binary-version=<value> Semver version that specifies the binary app version this release is compatible with -x, --[no-]disabled Specifies whether this release should not be immediately downloadable -y, --yes Accepts all confirmation prompts --description=<value> Description of the changes made to the app in this release --description-from-current-git-commit Use the current git commit message as the release description (truncated at 255 characters). --description takes precedence. --disable-duplicate-release-error When this flag is set, releasing a package that is identical to the latest release will produce a warning instead of an error --release-channel=<value> Release channel (eg. "myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e") REACT NATIVE BUNDLING FLAGS -b, --bundle-name=<value> Name of the generated JS bundle file. If unspecified, the standard bundle name will be used, depending on the specified platform: "main.jsbundle" (iOS), "index.android.bundle" (Android) or "index.windows.bundle" (Windows) -e, --entry-file=<value> Path to the app's entry JavaScript file. If omitted, "index.<platform>.js" and then "index.js" will be used (if they exist) -o, --output-dir=<value> Path to where the bundle should be written. If omitted, the bundle will not be saved on your machine -s, --sourcemap-output=<value> Path to where the sourcemap for the resulting bundle should be written. If omitted, a sourcemap will not be generated --development Specifies whether to generate a dev or release build --extra-bundler-option=<value>... [default: ] Option that gets passed to react-native bundler. Can be specified multiple times --extra-hermes-flag=<value>... [default: ] Flag that gets passed to Hermes, JavaScript to bytecode compiler. Can be specified multiple times --react-native-cli-path=<value> Path to the React Native CLI script in setups where the CLI is not in the standard location (eg. in a monorepo) --sentry-sourcemap-debug-id Update sourcemap with the bundle debug ID for Sentry --sourcemap-output-dir=<value> Path to folder where the sourcemap for the resulting bundle should be written. Name of sourcemap file will be generated automatically. This argument will be ignored if "sourcemap-output" argument is provided. If omitted, a sourcemap will not be generated --use-hermes Force using Hermes engine --use-jsc Force using JSC engine AUTOMATIC DETECTION OF TARGET BINARY VERSION AND HERMES USAGE FLAGS -c, --build-configuration-name=<value> [default: Release] Name of build configuration which specifies the binary version you want to target this release at. For example, "Debug" or "Release" (iOS only) -g, --gradle-file=<value> Path to the gradle file which specifies the binary version you want to target this release at (android only) -p, --plist-file=<value> Path to the plist file which specifies the binary version you want to target this release at (iOS only) --plist-file-prefix=<value> Prefix to append to the file name when attempting to find your app's Info.plist file (iOS only) --pod-file=<value> Path to the cocoapods config file (iOS only) --xcode-project-file=<value> Path to the Xcode project or project.pbxproj file --xcode-target-name=<value> Name of target (PBXNativeTarget) which specifies the binary version you want to target this release at (iOS only) AUTHENTICATION FLAGS -s, --api-key=<value> An API key that has access to this project. If there is a user logged in, the API key will take precedence. DESCRIPTION Deploy a React Native release ``` ## `appzung releases edit` Edit the metadata for an existing release ``` USAGE $ appzung releases edit [--release-channel <value>] [--release-version <value>] [--description <value>] [-m] [-x] [-t <value>] [-r <value>] [-s <value>] FLAGS -m, --[no-]mandatory Specifies whether this release should be considered mandatory -r, --rollout=<value> Percentage points of users this release should be available to (eg. 95 for 95%) -t, --target-binary-version=<value> Semver version that specifies the binary app version this release is compatible with -x, --[no-]disabled Specifies whether this release should not be immediately downloadable --description=<value> Description of the changes made to the app in this release AUTHENTICATION FLAGS -s, --api-key=<value> An API key that has access to this project. If there is a user logged in, the API key will take precedence. REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS --release-channel=<value> Release channel (eg. "myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e") --release-version=<value> Version number to edit DESCRIPTION Edit the metadata for an existing release ``` ## `appzung releases list` List releases in a release channel ``` USAGE $ appzung releases list [--release-channel <value>] [--page <value>] FLAGS --page=<value> Page REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS --release-channel=<value> Release channel (eg. "myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e") DESCRIPTION List releases in a release channel ``` ## `appzung releases promote` Promote a release from one channel to another ``` USAGE $ appzung releases promote [--source-release-channel <value>] [--target-release-channel <value>] [--source-release-version <value>] [--description <value>] [-m] [-x] [-t <value>] [-r <value>] [-s <value>] FLAGS -m, --[no-]mandatory Specifies whether this release should be considered mandatory -r, --rollout=<value> Percentage points of users this release should be available to (eg. 95 for 95%) -t, --target-binary-version=<value> Semver version that specifies the binary app version this release is compatible with -x, --[no-]disabled Specifies whether this release should not be immediately downloadable --description=<value> Description of the changes made to the app in this release --source-release-channel=<value> Source release channel (eg. "myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e") --source-release-version=<value> Specific version to promote from source release channel --target-release-channel=<value> Target release channel (eg. "myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e") AUTHENTICATION FLAGS -s, --api-key=<value> An API key that has access to this project. If there is a user logged in, the API key will take precedence. DESCRIPTION Promote a release from one channel to another ``` ## `appzung releases rollback` Rollback a release channel to a previous release version ``` USAGE $ appzung releases rollback [--release-channel <value>] [--target-release-version <value>] [-s <value>] FLAGS --release-channel=<value> Release channel (eg. "myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e") --target-release-version=<value> Specific version to rollback to (defaults to last known version) AUTHENTICATION FLAGS -s, --api-key=<value> An API key that has access to this project. If there is a user logged in, the API key will take precedence. DESCRIPTION Rollback a release channel to a previous release version ``` ## `appzung releases show` Show details about a specific release ``` USAGE $ appzung releases show [--release-channel <value>] [--release-version <value>] REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS --release-channel=<value> Release channel (eg. "myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e") --release-version=<value> Version number DESCRIPTION Show details about a specific release ``` ## `appzung version` ``` USAGE $ appzung version [--json] [--verbose] FLAGS --verbose Show additional information about the CLI. GLOBAL FLAGS --json Format output as json. FLAG DESCRIPTIONS --verbose Show additional information about the CLI. Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using. ``` _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v2.2.19/src/commands/version.ts)_ ## `appzung welcome` Welcome to AppZung CLI ``` USAGE $ appzung welcome DESCRIPTION Welcome to AppZung CLI ``` <!-- commandsstop -->