### AppZung CLI: Usage Example
Source: https://unpkg.com/@appzung/cli/README
Demonstrates the basic installation and usage of the AppZung CLI. It shows how to install the CLI globally and execute commands.
```sh-session
$ npm install -g @appzung/cli
$ appzung COMMAND
running command...
$ appzung (--version)
@appzung/cli/1.10.0 linux-x64 node-v22.16.0
$ appzung --help [COMMAND]
USAGE
$ appzung COMMAND
...
```
--------------------------------
### Install AppZung CLI
Source: https://github.com/appzung
Installs the AppZung Command Line Interface globally using npm. This is the first step to manage your CodePush deployments and interact with the platform.
```Shell
npm install -g @appzung/cli@1
```
--------------------------------
### AppZung CLI Commands
Source: https://github.com/appzung
Provides essential commands for interacting with the AppZung CodePush platform. Includes commands for initiating the welcome guide and migrating from AppCenter CodePush.
```Shell
appzung welcome
```
```Shell
appzung codepush migrate
```
--------------------------------
### AppZung CLI Installation and Usage
Source: https://context7_llms
This snippet covers the installation and basic usage of the AppZung CLI, a command-line interface for managing CodePush deployments. It is essential for developers interacting with the AppZung platform programmatically.
```bash
npm install -g @appzung/cli
# Initialize AppZung in your project
appzung init
# Deploy an update
appzung release "v1.0.0" --description "Initial release"
```
--------------------------------
### Install @appzung/react-native-code-push v5-v9
Source: https://raw.githubusercontent.com/AppZung/react-native-code-push/refs/heads/main/README
Instructions for updating your project's package.json to use specific older versions of @appzung/react-native-code-push (e.g., v9.0.2, 8.3.2, 7.1.1, 6.4.2, 6.3.1, 5.7.1). This is followed by standard package installation commands.
```javascript
{
"dependencies": {
"react-native-code-push": "npm:@appzung/react-native-code-push@^8.3.2"
}
}
```
```bash
npm install
# or
yarn install
bundle exec pod install
```
--------------------------------
### AppZung CLI Basic Commands
Source: https://raw.githubusercontent.com/AppZung/react-native-code-push/refs/heads/main/README
Provides essential commands for interacting with the AppZung CLI. These commands are used for initial setup, getting help, and managing app updates.
```shell
npx @appzung/cli@1 welcome
npx @appzung/cli@1 --help
```
--------------------------------
### appzung autocomplete command
Source: https://unpkg.com/@appzung/cli/README
Displays instructions for installing shell autocompletion for the Appzung CLI. Supports Zsh, Bash, and PowerShell, with an option to refresh the cache.
```APIDOC
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
```
--------------------------------
### Install AppZung CodePush Packages (sh)
Source: https://raw.githubusercontent.com/AppZung/expo-config-code-push/refs/heads/main/README
Installs the core `@appzung/react-native-code-push` and the `@appzung/expo-config-code-push` packages. This command ensures both the runtime and configuration parts of the CodePush integration are available for your Expo project.
```sh
npx expo install @appzung/react-native-code-push @appzung/expo-config-code-push
```
--------------------------------
### Install Expo Build Properties (sh)
Source: https://raw.githubusercontent.com/AppZung/expo-config-code-push/refs/heads/main/README
Installs the `expo-build-properties` package, which is optionally required to set the iOS deployment target for older Expo projects. This command uses `npx expo install` for compatibility with Expo managed projects.
```sh
npx expo install expo-build-properties
```
--------------------------------
### Manual Sync with Update Dialog
Source: https://raw.githubusercontent.com/AppZung/react-native-code-push/refs/heads/main/README
Demonstrates manual synchronization using `CodePush.sync()`. This example shows how to trigger an update check on a button press, display an update dialog, and install the update immediately. The app is configured to check updates manually.
```javascript
import withCodePush, { CheckFrequency, InstallMode, sync } from '@appzung/react-native-code-push';
class MyApp extends Component {
onButtonPress() {
sync({
updateDialog: true,
installMode: InstallMode.IMMEDIATE,
});
}
render() {
return (
Check for updates
);
}
}
export default withCodePush({ checkFrequency: CheckFrequency.MANUAL })(MyApp);
```
--------------------------------
### Install AppZung React Native CodePush
Source: https://raw.githubusercontent.com/AppZung/react-native-code-push/refs/heads/main/README
Installs the AppZung CodePush package for React Native applications using npm. This is the initial step to integrate dynamic update capabilities into your project.
```shell
npm install --save @appzung/react-native-code-push
```
--------------------------------
### AppZung React Native SDK Integration
Source: https://context7_llms
This documentation outlines the integration of the AppZung SDK for React Native applications. It details how to set up the SDK to enable over-the-air updates for your mobile app, including installation and basic configuration steps.
```bash
npm install --save @appzung/react-native-code-push
# or
yarn add @appzung/react-native-code-push
```
```javascript
import codePush from "react-native-code-push";
let codePushOptions = {
checkFrequency: codePush.CheckFrequency.ON_APP_START,
};
export default codePush(codePushOptions)(App);
```
--------------------------------
### appzung welcome command
Source: https://unpkg.com/@appzung/cli/README
Displays a welcome message for the AppZung CLI. It has no specific flags or parameters.
```APIDOC
USAGE
$ appzung welcome
DESCRIPTION
Welcome to AppZung CLI
```
--------------------------------
### Basic CodePush Integration
Source: https://raw.githubusercontent.com/AppZung/react-native-code-push/refs/heads/main/README
Integrates the CodePush plugin with your React Native app's root component. By default, it checks for updates on app start and installs them on the next restart.
```javascript
import withCodePush from '@appzung/react-native-code-push';
const MyApp = () => {};
export default withCodePush(MyApp);
```
--------------------------------
### appzung releases promote command
Source: https://unpkg.com/@appzung/cli/README
Promotes a release from a source release channel to a target release channel. Allows specifying the source version, description, mandatory status, rollout percentage, and target binary version. Requires authentication.
```APIDOC
appzung releases promote
Promote a release from one channel to another
USAGE
$ appzung releases promote [--source-release-channel ] [--target-release-channel ]
[--source-release-version ] [--description ] [-m] [-x] [-t ] [-r ] [-s ]
FLAGS
-m, --[no-]mandatory Specifies whether this release should be considered mandatory
-r, --rollout= Percentage points of users this release should be available to (eg. 95 for 95%)
-t, --target-binary-version= 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= Description of the changes made to the app in this release
--source-release-channel= Source release channel (eg.
"myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e")
--source-release-version= Specific version to promote from source release channel
--target-release-channel= Target release channel (eg.
"myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e")
AUTHENTICATION FLAGS
-s, --api-key= An API key that has access to this project. If there is a user logged in, the API key will take
precedence.
```
--------------------------------
### appzung help command
Source: https://unpkg.com/@appzung/cli/README
Displays help information for the Appzung CLI, including nested commands if requested.
```APIDOC
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.
```
--------------------------------
### Migrate from AppCenter
Source: https://appzung.com/faq
Command to initiate the migration process from AppCenter to AppZung. This tool helps fetch and select apps from AppCenter and migrate release channels.
```bash
npx @appzung/cli codepush migrate
```
--------------------------------
### Appzung Deploy React Native Help
Source: https://raw.githubusercontent.com/AppZung/react-native-code-push/refs/heads/main/README
Displays help information for the 'appzung releases deploy-react-native' command, outlining its available parameters and usage details.
```shell
appzung releases deploy-react-native --help
```
--------------------------------
### appzung releases deploy-react-native Command
Source: https://unpkg.com/@appzung/cli/README
This command deploys a React Native release to a specified channel. It supports various configurations for signing, rollout percentages, target binary versions, and bundling options. Users can specify descriptions, use Git commit messages, manage duplicate release errors, and control bundling behavior like entry files, output directories, and Hermes engine usage.
```APIDOC
appzung releases deploy-react-native
Deploy a React Native release
USAGE
$ appzung releases deploy-react-native [-h] [--release-channel ] [-r ] [-m] [-x] [--disable-duplicate-release-error] [-k ] [--description ] [--description-from-current-git-commit] [-s ] [-t ] [--use-package-json-version] [-b ] [--development] [--use-hermes] [--use-jsc] [--extra-hermes-flag ...] [--extra-bundler-option ...] [-e ] [-s ] [-o ] [--react-native-cli-path ] [--sentry-sourcemap-debug-id --sourcemap-output-dir ] [-g ] [--pod-file ] [-p ] [--xcode-project-file ] [--plist-file-prefix ] [-c ] [--xcode-target-name ] [-y]
FLAGS
-h, --help: Show CLI help.
-k, --private-key=: 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=: Percentage points of users this release should be available to (eg. 95 for 95%).
-t, --target-binary-version=: 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=: 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=: Release channel (eg. "myReleaseChannelDescription/c95d7950-228c-4f47-8abb-4e275050ca8e").
REACT NATIVE BUNDLING FLAGS
-b, --bundle-name=: 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=: Path to the app's entry JavaScript file. If omitted, "index..js" and then "index.js" will be used (if they exist).
-o, --output-dir=: Path to where the bundle should be written. If omitted, the bundle will not be saved on your machine.
-s, --sourcemap-output=: 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=...: Option that gets passed to react-native bundler. Can be specified multiple times.
--extra-hermes-flag=...: Flag that gets passed to Hermes, JavaScript to bytecode compiler. Can be specified multiple times.
--react-native-cli-path=: 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=: 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=: [default: Release] Name of build configuration which specifies the binary version you want to target this release at. For example, "Debug" or "Release".
```
--------------------------------
### appzung projects create command
Source: https://unpkg.com/@appzung/cli/README
Creates a new project within an organization. Requires organization slug and project name. Allows specifying project framework and release type, with an option to skip confirmation.
```APIDOC
appzung projects create
Create a new project
USAGE
$ appzung projects create [-o ] [-n ] [--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= Project name
-o, --org= Organization slug
--framework=