Package Exports
- @appzung/cli
- @appzung/cli/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@appzung/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@appzung/cli
AppZung CLI
Usage
$ npm install -g @appzung/cli
$ appzung COMMAND
running command...
$ appzung (--version)
@appzung/cli/1.11.0 linux-x64 node-v22.18.0
$ appzung --help [COMMAND]
USAGE
$ appzung COMMAND
...Commands
appzung applications createappzung applications editappzung applications listappzung auth loginappzung auth logoutappzung auth whoamiappzung autocomplete [SHELL]appzung billing active-users-historyappzung billing manageappzung billing subscribeappzung codepush migrateappzung help [COMMAND]appzung organizations api-keys createappzung organizations api-keys revokeappzung organizations createappzung organizations listappzung projects api-keys createappzung projects api-keys revokeappzung projects createappzung projects editappzung projects listappzung release-channels createappzung release-channels editappzung release-channels listappzung releases deployappzung releases deploy-expoappzung releases deploy-react-nativeappzung releases editappzung releases listappzung releases promoteappzung releases rollbackappzung releases showappzung versionappzung 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 applicationappzung 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 applicationappzung 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 projectappzung 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 tokenappzung auth logout
Logout from the current session
USAGE
$ appzung auth logout [--web]
FLAGS
--web Also logout the web session (eg. for a full reauthentication)
DESCRIPTION
Logout from the current sessionappzung auth whoami
Show currently logged in user
USAGE
$ appzung auth whoami [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show currently logged in userappzung 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-cacheSee code: @oclif/plugin-autocomplete
appzung billing active-users-history
Show active users history (billing period)
USAGE
$ appzung billing active-users-history
DESCRIPTION
Show active users history (billing period)appzung billing manage
Manage your subscription and billing info
USAGE
$ appzung billing manage
DESCRIPTION
Manage your subscription and billing infoappzung billing subscribe
Subscribe to a plan
USAGE
$ appzung billing subscribe
DESCRIPTION
Subscribe to a planappzung 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 AppCenterappzung 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
appzung organizations api-keys create
Create a new API key for an organization
USAGE
$ appzung organizations api-keys create [-o <value>] [-n <value>]
FLAGS
-n, --name=<value> API key name
REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS
-o, --org=<value> Organization slug
DESCRIPTION
Create a new API key for an organizationappzung organizations api-keys revoke
Revoke all API keys for an organization
USAGE
$ appzung organizations api-keys revoke [-o <value>]
REQUIRED IN NON-INTERACTIVE TERMINALS FLAGS
-o, --org=<value> Organization slug
DESCRIPTION
Revoke all API keys for an organizationappzung 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 organizationappzung organizations list
List your organizations
USAGE
$ appzung organizations list [--page <value>]
FLAGS
--page=<value> Page
DESCRIPTION
List your organizationsappzung 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 projectappzung 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 projectappzung 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 projectappzung 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 projectappzung 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 organizationappzung 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 channelappzung 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 channelappzung 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 applicationappzung releases deploy
Deploy a generic release
USAGE
$ appzung releases deploy -t <value> -c <value> [--json] [-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=<value> Specifies the path to private key file (or the private key string itself)
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.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Deploy a generic releaseappzung releases deploy-expo
Deploy an Expo release
USAGE
$ appzung releases deploy-expo [--json] [-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>] [--use-package-json-version] [--use-app-config-version] [--development] [-s <value>]
[--sourcemap-output-dir <value>] [-o <value>] [--expo-cli-path <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=<value> Specifies the path to private key file (or the private key string itself)
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")
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)
--use-app-config-version Use the version from app.json as the target binary version instead of
auto-detecting from native files
--use-package-json-version Use the version from package.json as the target binary version instead of
auto-detecting from native files
--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)
REACT NATIVE BUNDLING FLAGS
-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
--expo-cli-path=<value> Path to the Expo CLI script in setups where the CLI is not in the standard
location (eg. in a monorepo)
--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
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.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Deploy an Expo releaseappzung releases deploy-react-native
Deploy a React Native release
USAGE
$ appzung releases deploy-react-native [--json] [-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>] [--use-package-json-version] [-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=<value> Specifies the path to private key file (or the private key string itself)
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)
--use-package-json-version Use the version from package.json as the target binary version instead of
auto-detecting from native files
--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.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Deploy a React Native releaseappzung 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 releaseappzung 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 channelappzung 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 anotherappzung 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 versionappzung 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 releaseappzung 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
appzung welcome
Welcome to AppZung CLI
USAGE
$ appzung welcome
DESCRIPTION
Welcome to AppZung CLI