XTD

Build Automation - CI/CD Integration

App Protection CLI Tool (vmx-aps)

For environments outside GitHub or for more customized workflows, XTD provides a Command-line interface (CLI) tool, available as a Python package on PyPI.

Prerequisites

  • Python
  • Pipenv

Installation

Ensure you have the prerequisites installed, then install the CLI tool using pipenv and pip:

$ pipenv shell
$ pip install vmx-aps

The use of pipenv is recommended and sometimes required (depending on your Python setup).

API Keys

The CLI relies on API keys from the XTD platform. See API Keys for more details.

Usage

After installation, you can use the vmx-aps command to protect your application:

$ vmx-aps --api-key-file "~~/Downloads/api-key.json " protect --file "~~/my-app.apk"

Replace the placeholders with your actual values:

  • --api-key-file: Path to your api-key.json file
  • --file: Path to your application file

For more detailed usage instructions and options, refer the CLI PyPI page.

On this page