Diaload-cli NPM

Diaload CLI

The Diaload command line interface (CLI) is a unified tool for running Diaload console services from the command line. Our aim is to offer a concise and powerful tool for our developers to use Diaload services and easily script a sequence of commands that they'd like to execute. You can currently log in and create/view all the apps and releases that you have access to in Diaload. You can also create access tokens that you can use in automated workflows

Installation

NPM:

npm install -g diaload-cli

Yarn:

yarn global add diaload-cli

Commands

1. Login

Login to the Diaload CLI session. Session will expire after 15 minutes of inactivity, and after 1 hour regardless of activity.

diaload login -u <username>

Options:

-u, --username <username>: Your console username (Required)

2. Create App

Create a new application on the Diaload platform.

diaload create-app -n <name> -d <description> -pkg <package_name> -plt <platform>

Options:

-n, --name <name>: Name of the app (Required)
-d, --description <description>: Description of the app (Required)
-pkg, --package <package_name>: Package name e.g., com.my.app (Required)
-plt, --platform <platform>: Platform (Accepted values: Android, iOS) (Required)

3. Create Release

Upload a new release for a specified app.

diaload create-release -n <notes> -a <app_id> -f <file_path> -g <group_Id>

Options:

-n, --notes <notes>: Release notes (Required)
-a, --app-id <app_id>: ID of the app for which the release is being created (Required)
-f, --file <file_path>: Path to the app package (IPA, APK, or AAB) (Required)
-g, --group-id <group_id>: Adds this release to a testing group. If the group denoted by this ID does not exist, it will be ignored, (Optional)

4. List Apps

Display a list of all your apps.

diaload list-apps [-v]

Options:

-v, --verbose: Show extended app data. By default, only ID and name are displayed.

5. List Releases

Display a list of all your app releases for a specific app.

diaload list-releases -a <app_id> [-v]

Options:

-a, --app-id <app_id>: ID of the app to retrieve releases for (Required)
-v, --verbose: Show extended release data. By default, only ID and name are displayed.

6. Create Access Token

Create an access token. Access tokens can be used in automated workflows like GitHub actions, fastlane etc

diaload create-token

7. Add release to group

Add a release to a testing group. If the release has already been added to the group, this action will have no effect.

diaload add-to-group -g <group_Id> -r <release_id>

Options:

-g, --group-id <group_id>: ID of the testing group (Required)
-r, --release-id <release_id>: ID of the release to add to testing group

8. Logout

Log out of your current CLI session

diaload logout

Use in GitHub Actions

name: Diaload Release Workflow

on:
  push:
    branches:
      - test
    
jobs:
  create-release:
    runs-on: ubuntu-latest
    
    steps:
    - name: Checkout code
      uses: actions/checkout@v2
      
    - name: Set up Node.js
      uses: actions/setup-node@v2
      with:
        node-version: '14' # or your desired version

    - name: Install Diaload CLI
      run: npm install -g diaload-cli
        
    - name: Install dependencies
      run: npm install
      
    - name: Run the create-release command
      run: diaload create-release -n "Automated release notes" -a ${{ secrets.APP_ID }} -f app/build/outputs/apk/develop/debug/my-app-file.apk
      env:
        DIALOAD_ACCESS_TOKEN: ${{ secrets.DIALOAD_ACCESS_TOKEN }}