# appupgrade-cli

> CLI tool for App Upgrade.

Latest version **1.0.0** (published 2022-05-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install appupgrade-cli
pnpm add appupgrade-cli
yarn add appupgrade-cli
bun add appupgrade-cli
```

Provides the command `appupgrade-cli`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-05-28 |
| First published | 2022-05-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 9 |
| Unpacked size | 77.1 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | App Upgrade @appupgrade-dev |
| Maintainers | appupgrade.dev |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/appupgrade-cli
- Repository: https://github.com/appupgrade-dev/appupgrade-cli
- Issues: https://github.com/appupgrade-dev/appupgrade-cli/issues
- npm.io page: https://npm.io/package/appupgrade-cli

## Dependencies (9)

- [conf](https://npm.io/package/conf.md) ^10.1.2
- [axios](https://npm.io/package/axios.md) ^0.27.2
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^1
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5.1.12
- [@oclif/plugin-update](https://npm.io/package/@oclif/plugin-update.md) ^3.0.0
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^2.1.0
- [@oclif/plugin-commands](https://npm.io/package/@oclif/plugin-commands.md) ^2.1.0
- [@oclif/plugin-not-found](https://npm.io/package/@oclif/plugin-not-found.md) ^2.3.1
- [@oclif/plugin-warn-if-update-available](https://npm.io/package/@oclif/plugin-warn-if-update-available.md) ^2.0.4

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-05-28
- 0.0.2 — 2022-05-28

## README

# App Upgrade CLI tool

### Official [App Upgrade](https://appupgrade.dev) Command Line Interface

* [Install](#install)
* [Usage](#usage)
* [Commands](#commands)
# Installation
```sh-session
$ npm install -g appupgrade-cli
```

# Usage
```sh-session
$ appupgrade-cli --version
appupgrade-cli/0.0.0 win32-x64 node-v16.0.0

$ appupgrade-cli --help
CLI tool for App Upgrade.

VERSION
  appupgrade-cli/0.0.0 win32-x64 node-v16.0.0

USAGE
  $ appupgrade-cli [COMMAND]

TOPICS
  auth     Authenticate with App Upgrade!
  plugins  List installed plugins.
  project  Manage project!
  user     User details!
  version  Manage version!

COMMANDS
  commands  list all the commands
  hello     Hello from App Upgrade!
  help      Display help for appupgrade-cli.
  plugins   List installed plugins.
  update    update the appupgrade-cli CLI

$ appupgrade-cli --help <TOPIC>
Ex: appupgrade-cli --help auth

$ appupgrade-cli --help <COMMAND>
Ex: appupgrade-cli --help hello

$ appupgrade-cli --help <TOPIC> <COMMAND>
Ex: appupgrade-cli --help auth login
```

# Commands
* [`appupgrade-cli hello`](#appupgrade-cli-hello)
* [`appupgrade-cli auth login`](#appupgrade-cli-auth-login)
* [`appupgrade-cli auth logout`](#appupgrade-cli-auth-logout)
* [`appupgrade-cli user me`](#appupgrade-cli-user-me)
* [`appupgrade-cli project create`](#appupgrade-cli-project-create)
* [`appupgrade-cli project update`](#appupgrade-cli-project-update)
* [`appupgrade-cli project list`](#appupgrade-cli-project-list)
* [`appupgrade-cli project get`](#appupgrade-cli-project-get)
* [`appupgrade-cli project delete`](#appupgrade-cli-project-delete)
* [`appupgrade-cli project change-api-key`](#appupgrade-cli-project-change-api-key)
* [`appupgrade-cli version create`](#appupgrade-cli-version-create)
* [`appupgrade-cli version update`](#appupgrade-cli-version-update)
* [`appupgrade-cli version list`](#appupgrade-cli-version-list)
* [`appupgrade-cli version get`](#appupgrade-cli-version-get)
* [`appupgrade-cli version delete`](#appupgrade-cli-version-delete)
* [`appupgrade-cli version check-version`](#appupgrade-cli-check-version)

## `appupgrade-cli-hello`
```sh-session
appupgrade-cli hello
Hello from App Upgrade! (./src/commands/hello/hello.ts)
```
## `appupgrade-cli-auth-login`
```sh-session
appupgrade-cli auth login --email=<EMAIL> --password=<PASSWORD>
```
## `appupgrade-cli-auth-logout`
```sh-session
appupgrade-cli auth logout
```
## `appupgrade-cli-user-me`
```sh-session
appupgrade-cli user me
```
## `appupgrade-cli-project-create`
```sh-session
appupgrade-cli project create  --name=Wallpaper --description="created using cli”
```
## `appupgrade-cli-project-update`
```sh-session
appupgrade-cli project update  --name=Wallpaper --description="updated using cli”
```
## `appupgrade-cli-project-list`
```sh-session
appupgrade-cli project list
```
## `appupgrade-cli-project-get`
```sh-session
appupgrade-cli project get —projectId=6252140e6f35ca0027f1900c
```
## `appupgrade-cli-project-delete`
```sh-session
appupgrade-cli project delete --projectId=62916711766f9c00273a61ae
```
## `appupgrade-cli-project-change-api-key`
```sh-session
appupgrade-cli project change-api-key --projectId=629167fe766f9c00273a61c7 --xApiKey=<YOUR_CURRENT_API_KEY>
```
## `appupgrade-cli-version-create`
```sh-session
appupgrade-cli version create --projectId=6252140e6f35ca0027f1900c --appName=”Wallpaper app” --appVersion=1.0.1 --platform=android --environment=production --forceUpgrade=true --message="please update”
```
## `appupgrade-cli-version-update`
```sh-session
appupgrade-cli version update --projectId=6252140e6f35ca0027f1900c --versionId=627ca8af732bcecab45351cc --appName=”Wallpaper app” --appVersion=1.0.1 --platform=android --environment=production --forceUpgrade=true --message="please update”
```
## `appupgrade-cli-version-list`
```sh-session
appupgrade-cli version list --projectId=6252140e6f35ca0027f1900c
```
## `appupgrade-cli-version-get`
```sh-session
appupgrade-cli version get --projectId=6252140e6f35ca0027f1900c --versionId=627ca8af732bcecab45351cc
```
## `appupgrade-cli-version-delete`
```sh-session
appupgrade-cli version get --projectId=6252140e6f35ca0027f1900c --versionId=627ca8af732bcecab45351cc
```
## `appupgrade-cli-check-version`
```sh-session
appupgrade-cli version check-version --xApiKey=ODdiNzg4NmQtNTZiMS00ZTFmLTk0YWMtOGRjYjM3M2UwYjE2 --appName="Translator User App" --appVersion=1.0.1 --platform=android --environment=production
```

### Optional Parameters/Flags
```sh-session
FLAGS
  -x, --extended       show extra columns
  --columns=<value>    only show provided columns (comma-separated)
  --csv                output is csv format [alias: --output=csv]
  --filter=<value>     filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --output=<option>    output in a more machine friendly format
                       <options: csv|json|yaml>
  --sort=<value>       property to sort by (prepend '-' for descending)
```

## App Upgrade Docs
For more information visit [App Upgrade](https://docs.appupgrade.dev/#/cli)

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

### Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE OF CONDUCT](CODE_OF_CONDUCT.md) for details.

### License

The MIT License (MIT). Please see [License File](LICENSE) for more information.

### Happy Coding!!!

---
_Source: https://npm.io/package/appupgrade-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._