Getting Started

February 6, 2026 ยท View on GitHub

Purpose

Get to a successful first run quickly, then branch into the right workflow guide.

Prerequisites

AreaRequirement
Neovim0.9+ with Lua support
AndroidAndroid SDK tools and adb
iOS (optional)Xcode tools
Picker UITelescope optional, vim.ui fallback is supported

Setup

  1. Add this lazy.nvim plugin spec:
{
  "iamironz/android-nvim-plugin",
  lazy = false,
  config = function()
    require("android").setup()
  end,
}
  1. Run :Lazy sync.
  2. Restart Neovim.

If you use another plugin manager, see install.md.

First Successful Run

  1. Open a project root.
  2. Run :AndroidMenu.
  3. Select a section using [1], [2], or <CR>.
  4. Use / for search, <Left> to go back, and <Right> to open selection.

Validate Environment

If setup fails, run :checkhealth android first.

Common issue path: support/troubleshooting.md#sdk-not-found

Next Steps