@appaudix/cli
v1.1.0
Published
AppAudix mobile security scanner CLI
Maintainers
Readme
@appaudix/cli
Command-line scanner for AppAudix mobile security analysis. Submit
.apk, .aab, or .ipa files to api.appaudix.com from your terminal
or CI pipeline.
Install
npm install -g @appaudix/cliRequires Node.js 18 or later.
Quick start
# 1. Authenticate
appaudix login --key sk_live_xxxxxxxxxxxxxxxx
# 2. Scan a build
appaudix scan ./build/app.apk
# 3. Get the report
appaudix report <scan_id> --format pdfCommands
| Command | What it does |
|---|---|
| appaudix login | Store your API key locally |
| appaudix logout | Clear the stored API key |
| appaudix scan <file> | Upload an APK / AAB / IPA and wait for results |
| appaudix scans | List recent scans |
| appaudix scans <id> | Inspect one scan |
| appaudix report <id> | Download the report (PDF, HTML, or JSON) |
Run appaudix <command> --help for the per-command options.
CI usage
appaudix scan ./build/app.apk \
--fail-on high \
--webhook https://your-ci.example.com/appaudix \
--callback-id "build-$GITHUB_RUN_ID"--fail-on <severity> makes the CLI exit non-zero when findings reach
that severity. Defaults to critical.
API access
The CLI calls https://api.appaudix.com/v1/*. API access requires an
Enterprise plan. Generate an API key on
appaudix.com/ApiKeys.
A GitHub Action is also available: appaudix/scan-action.
Docs
Full reference: https://appaudix.com/docs/cli
Changelog
See CHANGELOG.md. Notable: v1.0.4 fixes every endpoint
(v1.0.3 was talking to a non-existent /v2 surface).
License
Proprietary. © 2025–2026 AppAudix, LLC. Contact [email protected].
