Skip to content

Commit

Permalink
Update args with --
Browse files Browse the repository at this point in the history
  • Loading branch information
@Massad
Massad committed Mar 27, 2022
2 parents 8b2d09d + ed249ea commit 69d2e35
Showing 1 changed file with 42 additions and 35 deletions.
77 changes: 42 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
# [<img src="https://assets.testapp.io/logo/blue.svg" alt="TestApp.io"/>](https://testapp.io/) CLI

> This is in BETA mode. Your feedback is highly appreciated.
> BETA mode. Your feedback is highly appreciated!
This is the official CLI (ta-cli) for [TestApp.io](https://testapp.io) app distribution to upload your Android (APK) and iOS (IPA) directly from this command line and notify your team members about the new releases if you enable it.
Official CLI (ta-CLI) for [TestApp.io](https://testapp.io) app distribution to upload your Android (APK) and iOS (IPA) directly from this command line and notify your team members to install and share feedback.

🎉 Join our [Slack](https://join.slack.com/t/testappio/shared_invite/zt-pvpoj3l2-epGYwGTaV3~3~0f7udNWoA) channel for feedback and support!

![Screen Shot 2021-06-05 at 12 50 14 AM](https://user-images.githubusercontent.com/3076722/120862504-1f8e7f80-c59a-11eb-93ca-71f677855020.png)
![TA-CLI Screenshot](https://user-images.githubusercontent.com/3076722/120862504-1f8e7f80-c59a-11eb-93ca-71f677855020.png)

## Installation

#### MacOS & Linux

```bash
```sh
curl -Ls https://github.com/testappio/cli/releases/latest/download/install | bash
```

Expand All @@ -22,7 +20,7 @@ Currently, we are not supporting `ta-cli config` for Windows.

Download latest [windows release](https://github.com/testappio/cli/releases/latest/download/ta-cli_windows.zip) and unzip it

```
```sh
ta-cli.exe publish --api_token=[Your API Token] --app_id=[Your AppID] --release=android --apk=C:/path/to/app.apk
```

Expand All @@ -32,13 +30,13 @@ ta-cli.exe publish --api_token=[Your API Token] --app_id=[Your AppID] --release=

You can use `vim` if installed `vim $HOME/.ta-cli.json`

```bash
```json
{
"api_token": "Your API Token",
"app_id": "Your App ID",
"release": "android",
"release": "both",
"apk": "/user/path/to/android/app.apk",
"ipa": "",
"ipa": "/user/path/to/ios/app.ipa",
"release_notes": "",
"git_release_notes": true,
"git_commit_id": false,
Expand All @@ -48,7 +46,7 @@ You can use `vim` if installed `vim $HOME/.ta-cli.json`

2. From your terminal, navigate to the extracted folder

```
```sh
ta-cli.exe publish
```

Expand All @@ -58,52 +56,61 @@ Navigate to [latest releases](https://github.com/testappio/cli/releases) and dow

## Configuration

```bash
```sh
ta-cli config
```

> `api_token`: You can get it from https://portal.testapp.io/settings/api-credentials
> `app_id`: You can get it from your app page at https://portal.testapp.io/apps
> `release`: It can be either `both` or `android` or `ios`
> `apk`: /user/path/to/app.apk (if you select release `both` or `android`)
> `ipa`: /user/path/to/app.ipa (if you select release `both` or `ios`)
> `release_notes`: Manually add the release notes to be displayed for the testers
> `git_release_notes`: Collect release notes from the latest git commit message to be displayed for the testers: `true` or `false`
> `include_git_commit_id`: Iclude the last commit ID in the release notes (works with both release notes option): `true` or `false`
> `notify`: Send notifications to your team members about this release: `true` or `false`
| Key | Description | Default |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| --config | path to your ta-cli.json config file [Optional] | $HOME/.ta-cli.json |
| --api_token | You can get it from https://portal.testapp.io/settings/api-credentials | |
| --app_id | You can get it from your app page at [https://portal.testapp.io/apps](https://portal.testapp.io/apps?select-for-integrations) | |
| --release | It can be either both or Android or iOS | |
| --apk_file | Path to the Android APK file | |
| --ipa_file | Path to the iOS IPA file | |
| --release_notes | Manually add the release notes to be displayed for the testers | |
| --git_release_notes | Collect release notes from the latest git commit message to be displayed for the testers: true or false | true |
| --git_commit_id | Include the last commit ID in the release notes (works with both release notes options): true or false | false |
| --notify | Send notifications to your team members about this release: true or false | false |

The default configuration file will be at `$HOME/.ta-cli.json`

## Publish

```bash
```sh
ta-cli publish
```

To override any value in the config:

```bash
ta-cli publish --release=android --release_notes="my release notes" --include_git_commit_id=true
```sh
ta-cli publish --release=android --release_notes="my release notes" --git_release_notes=true --git_commit_id=true
```

## Config path

Default directories in order:

1. input path from `--config=`
2. .ta-cli.json
3. $HOME/.ta-cli.json

```sh
ta-cli publish --config=ta-cli.json
```

For more info about the list of options:

```bash
```sh
ta-cli publish -h
```

## Feedback & Support

Join our [Slack](https://join.slack.com/t/testappio/shared_invite/zt-pvpoj3l2-epGYwGTaV3~3~0f7udNWoA) channel for feedback and support, or you can contact us at [email protected], and we'll gladly help you out!
Developers built [TestApp.io](https://testapp.io) to solve the pain of app distribution for mobile app development teams.

Join our [Slack](https://join.slack.com/t/testappio/shared_invite/zt-pvpoj3l2-epGYwGTaV3~3~0f7udNWoA) channel for feedback and support.

---
Check out our [Help Center](https://help.testapp.io/) for more info and other integrations.

Happy releasing 🎉

0 comments on commit 69d2e35

Please sign in to comment.