> For the complete documentation index, see [llms.txt](https://docs.hex-rays.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hex-rays.com/ida-9.5/add-ons/assist/getting-started.md).
# Getting Started
{% hint style="warning" %}
Assist is new in the IDA 9.5 beta, and its documentation is subject to change. Treat it as a work in progress rather than a finished reference.
{% endhint %}
Get up and running with Assist: an AI harness for reverse engineering, built directly into IDA.
This tutorial walks you through installation and first setup. Once installed, you can invoke it with Ctrl+Shift+K, from the **Edit → Plugins → Assist**, or from the right-click context menu on a selection, when available.
## Prerequisites
* IDA 9.3, 9.4 or 9.5 (IDA Home, IDA Pro)
* A Hex-Rays account with access to Assist
* [hcli](https://hcli.docs.hex-rays.com/), the Hex-Rays command-line tool (recommended)
## Installation
### Recommended: install with hcli
hcli installs Assist from the Hex-Rays plugin portal and keeps it up to date.
1. **Install hcli.** Follow the [hcli installation guide](https://hcli.docs.hex-rays.com/install).
2. **Log in to your Hex-Rays account.** Assist can only be downloaded by accounts that have access to it, so hcli must be logged in before it can install Assist:
```bash
hcli login
```
3. **Install Assist:**
```bash
hcli plugin install hexrays/assist
```
hcli installs Assist in your IDA user plugins directory (`$IDAUSR/plugins/assist/`), not in the IDA installation folder.
4. **Restart IDA.**
### Update Assist
Assist checks the plugin portal and shows a notice when a newer release is out. To update, run the following command, then restart IDA:
```bash
hcli plugin upgrade hexrays/assist
```
`hcli plugin status` shows the installed version and whether an upgrade is available.
### Alternative: install manually
1. Download the Assist archive for your platform from the [My Hex-Rays portal](https://my.hex-rays.com/dashboard/download-center).
2. Extract it and copy the contents of its `plugins` folder into your IDA user plugins directory:
* macOS and Linux: `~/.idapro/plugins/`
* Windows: `%APPDATA%\Hex-Rays\IDA Pro\plugins\`
The result is `…/plugins/assist/ida-plugin.json` with the Assist binaries beside it. You can also install the downloaded archive with hcli: `hcli plugin install .zip`.
{% hint style="warning" %}
**macOS:** the Assist add-on is not notarized. On first launch macOS may block it. Ad-hoc sign it once after installing: `codesign --force --sign - ~/.idapro/plugins/assist/assist.dylib`. On a managed corporate machine you may need administrator help to allow the add-on.
{% endhint %}
## First run
1. Open IDA and load the binary you want to analyze.
2. To invoke Assist, press Ctrl+Shift+K, or navigate to **Edit → Plugins → Assist**.
The first time you open Assist, an onboarding wizard walks you through a few steps.
### Choose and configure a model
1. Select which model backend Assist will drive: a **built-in agent** that runs inside IDA with nothing to install, or **an agent you already use** (Claude Code, ChatGPT, Grok, or an API key/local endpoint), a separate program with its own sandbox that reaches the database through Assist. Assist found the models installed on your machine and proposes a possible setup.
{% hint style="info" %}
You can change the agent later in **Settings**.
{% endhint %}
### Settle permissions
Decide what Assist is allowed to do. Reading the database is always allowed; pick one of three modes for everything else: **Look, don't touch**, **Ask before changes** (recommended), or **Work freely**. You can change it later in **Settings → Permissions**.
### Explore the Assist panel
Assist is dockable like any other IDA view, but has its own specific parts. More options, like Memory or Permissions, you'll find under Settings.
### Go with the first prompt
Pick one of the suggested prompts to see Assist in action right away, or start from an empty composer.
Once configured, Assist is ready and opened as an IDA view. Type a prompt or use the proposed one, mention a function with `@`, reference an address with `#`, or run a slash `/command` from the start of the input.
### Bring your terminal agent (optional)
If you also work in Claude Code, Codex or Grok, they can use this database through Assist, with the permissions you just chose. If you only use the panel, there is nothing to do here.
Pick your agent's tab and run the command it gives you in a terminal. The first time it connects, IDA asks whether to allow it.
## What's next
* See [Concepts](/ida-9.5/add-ons/assist/concepts.md) for how Assist works under the hood.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.hex-rays.com/ida-9.5/add-ons/assist/getting-started.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.