Everything the binary accepts.
Run apiaxess with no arguments and you get the workbench. Give it a command and it does that instead. This is the help text as the binary prints it, for version 0.1.0.
Six ways to start.
- apiaxess
- Launch the local workbench
- serve
- Run headless and serve the interface until Ctrl-C
- web
- Start a web capture session against a domain or URL
- analyze
- Run the APK analysis pipeline
- inspect
- Read back a session artefact
- export
- Write the surface out as OpenAPI, Postman, HAR or a Python client
apiaxess --help, verbatim.
APIaxess
Commands:
apiaxess Launch the local workbench (loopback UI)
apiaxess serve [--port <n>] [--host <addr>] Run headless: serve the UI on a port until Ctrl-C
apiaxess analyze <apk> [options]
apiaxess web <domain-or-url> --authorize [options]
apiaxess inspect <session> [--json]
Web options:
--authorize Affirm that you are authorized to test this target (required)
--output <path> Persist the web session artifact at this path
--json Print the started session status as JSON
Analyze options:
--static-only Run the static pipeline only (default)
--dynamic Request dynamic enrichment when session evidence exists
--session <path> Resume an existing session artifact
--output <path> Persist a new session artifact at this path
--scope <json|@file> Declare the complete session EngagementScope
--allow-target <host> Add an allowed host rule (repeatable)
--staged-credential <kind=value> Pre-stage a login credential for the crawler,
keyed by field kind (phone, otp, password, pin, email,
username). Repeatable.
--session-id <id> Set the ID for a new session
--intake-output <dir> Store normalized intake output below this directory
--json Print the unified surface as JSON
-h, --help Show this help
APK analysis uses APIaxess's bundled Java runtime, apktool, and jadx by
default, so nothing is required on the host. Advanced overrides:
APIAXESS_JAVA, APIAXESS_APKTOOL, APIAXESS_JADX (a .jar value runs through the
bundled runtime; anything else is treated as a self-contained launcher).Export: apiaxess export <session> --format <openapi|sdk|postman|har|all> --out <dir> [--json]