Command Reference

March 25, 2026 ยท View on GitHub

Scope

This page defines the zero-arg command surface, default shortcuts, <Plug> mappings, and AndroidMenu inventory.

For step-by-step usage, see navigation guide, build and deploy guide, and logcat guide.

Commands With Default Shortcuts

CommandDescriptionDefault ShortcutPlug Mapping
:AndroidMenuShow main hub menu<leader>am<Plug>(AndroidMenu)
:AndroidTargetsShow Build Variants hub<leader>at<Plug>(AndroidTargets)
:AndroidToolsShow Device Manager and ADB hub<leader>ao<Plug>(AndroidTools)
:AndroidActionsShow actions hub<leader>aa<Plug>(AndroidActions)
:AndroidBuildBuild Android with saved defaults<leader>ab<Plug>(AndroidBuild)

Direct Commands (No Default Shortcut)

CommandDescriptionPlug Mapping
:AndroidRunRun current config<Plug>(AndroidRun)
:AndroidRunStopStop active run jobs<Plug>(AndroidRunStop)
:AndroidLogcatOpen logcat panel<Plug>(AndroidLogcat)
:AndroidBuildPromptBuild Android with prompts<Plug>(AndroidBuildPrompt)
:AndroidBuildAssembleBuild Android assemble only<Plug>(AndroidBuildAssemble)
:AndroidGradleTasksOpen composite-aware Gradle task picker<Plug>(AndroidGradleTasks)
:AndroidIOSBuildBuild iOS project<Plug>(AndroidIOSBuild)
:AndroidIOSDeployDeploy iOS project<Plug>(AndroidIOSDeploy)

Diagnostics

  • :checkhealth android validates SDK tools, Gradle command resolution, and iOS tooling on macOS.

AndroidMenu Items

Items appear only when workspace capabilities and current run target context support them. Android and iOS actions can be hidden when the selected run target is incompatible.

SectionItemNotes
Run ConfigurationsRun config entriesSelect active run configuration (* marks current)
RunRun currentRuns selected run config
RunStop runStops active run jobs
Build VariantsBuild defaultBuild and deploy using saved module and variant
Build VariantsBuild assemble onlyBuild without deploy
Build VariantsBuild with promptsPick module and variant before building
Build VariantsiOS buildRequires iOS workspace
Build VariantsiOS deployRequires iOS workspace and available simulator/device
Build VariantsGradle tasksBrowse and run composite-aware Gradle tasks
Build VariantsSelect moduleSet default Gradle module and sync matching Android run config when active
Build VariantsSelect variantSet default build variant
Build VariantsOutput APKsList APKs and copy path
Build VariantsGradle cleanRun clean in workspace
Device ManagerSelect devicePick default adb device
Device ManagerSelect emulator AVDPick default emulator profile
Device ManagerStart emulatorLaunch default emulator
Device ManagerCreate AVDCreate new emulator profile
Device ManagerStop emulatorStop running emulator
ADBADB installInstall APK to selected device
ADBClear app dataClear app data on selected device
ADBUninstall appRemove app from selected device
LogcatLogcatOpen logcat panel
LogcatHealth checkRun :checkhealth android
LogcatShow build errorsOpen build quickfix list

Examples

  1. Open the full hub: :AndroidMenu
  2. Run the selected config directly: :AndroidRun
  3. Build without deploy: :AndroidBuildAssemble
  4. Select a different Android module from Build Variants to keep Android build defaults and the active Android run config aligned.
  5. Add a custom key for a direct command:
vim.keymap.set("n", "<leader>ar", "<Plug>(AndroidRun)", { remap = true, silent = true })