CLI Reference
This page lists every HCLI command and its options. The text comes from the help text in the HCLI source code. Add --help to a command to see the same text in a terminal, for example hcli plugin install --help.
hcli extension is an alias for hcli plugin.
hcli
Hex-Rays Command-line interface for managing IDA installation, licenses and more.
Usage:
[1mhcli[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--auth, -a |
text | Force authentication type: interactive or key | None |
--auth-credentials, -s |
text | Force specific credentials by name | None |
--disable-updates |
boolean | Disable automatic update checking | False |
--help |
boolean | Show this message and exit. | False |
Subcommands
- auth: Manage hcli api keys.
- commands: List all available command combinations.
- download: Download IDA binaries, SDKs, and utilities.
- hcli-extensions: Manage hcli extensions.
- ida: Manage IDA installations.
- license: Manage IDA licenses.
- login: Log in to the Hex-Rays portal and create new credentials.
- logout: Log out and remove stored credentials.
- mcp: IDA MCP integrations for AI coding agents.
- plugin: Manage IDA Pro plugins.
- share: Share files with Hex-Rays.
- update: Check for hcli updates.
- whoami: Display the currently logged-in user.
hcli auth
Manage hcli api keys.
Usage:
[1mhcli auth[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- default: Set or show the default credentials.
- key: API key management.
- list: List all credentials.
- switch: Switch the default credentials.
hcli auth default
Set or show the default credentials.
Usage:
[1mhcli auth default[0m [[1;36mOPTIONS[0m] [[1;36mNAME[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli auth key
API key management.
Usage:
[1mhcli auth key[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- create: Create a new API key.
- install: Install an API key as a new credentials.
- list: List all API keys.
- revoke: Revoke an API key.
hcli auth key create
Create a new API key.
Usage:
[1mhcli auth key create[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-n, --name |
text | Name for the new key | None |
--help |
boolean | Show this message and exit. | False |
hcli auth key install
Install an API key as a new credentials.
Usage:
[1mhcli auth key install[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-k, --key |
text | API key to install | None |
-n, --name |
text | Custom name for the credentials | None |
--key-name |
text | Name for the API key | None |
--set-default |
boolean | Set as default credentials | False |
--help |
boolean | Show this message and exit. | False |
hcli auth key list
List all API keys.
Usage:
[1mhcli auth key list[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli auth key revoke
Revoke an API key.
Usage:
[1mhcli auth key revoke[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli auth list
List all credentials.
Usage:
[1mhcli auth list[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli auth switch
Switch the default credentials.
Usage:
[1mhcli auth switch[0m [[1;36mOPTIONS[0m] [[1;36mNAME[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli commands
List all available command combinations.
Usage:
[1mhcli commands[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli download
Download IDA binaries, SDKs, and utilities.
KEY: The asset key for direct download eg. release/9.1/ida-pro/ida-pro_91_x64linux.run (optional)
Can also be a tag in one of these formats: - 'category:version' (e.g., 'ida-pro:latest' or 'ida-pro:9.2') - OS is auto-detected - 'category:version:os' (e.g., 'ida-pro:latest:armmac') - explicit OS specification
When using direct mode, a pattern is required.
Usage:
[1mhcli download[0m [[1;36mOPTIONS[0m] [[1;36mKEY[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-f, --force |
boolean | Skip cache | False |
--mode |
text | One of interactive or direct | interactive |
--output-dir |
text | Output path | ./ |
--pattern |
text | Pattern to search for assets | None |
--list-tags |
boolean | List all available download tags and exit | False |
--help |
boolean | Show this message and exit. | False |
hcli hcli-extensions
Manage hcli extensions.
Usage:
[1mhcli hcli-extensions[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
hcli hcli-extensions create
Create an hcli extension
Usage:
hcli hcli-extensions create [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli hcli-extensions list
List hcli extensions
Usage:
hcli hcli-extensions list [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli ida
Manage IDA installations.
Usage:
[1mhcli ida[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- accept-eula: Accept the IDA EULA for an installation.
- add: Add an IDA Pro instance.
- install: Installs IDA unattended.
- list: List all registered IDA Pro instances.
- open: Open an ida:// link in the appropriate IDA instance.
- protocol: Manage ida:// protocol handlers.
- python: Use the Python environment that IDA loads.
- remove: Remove an IDA Pro instance.
- set-default: Set or show the default IDA installation directory.
- source: Manage named sources for IDB file lookup.
- switch: Switch the default IDA Pro instance.
hcli ida accept-eula
Accept the IDA EULA for an installation.
If no PATH is provided, uses the default IDA installation.
Usage:
[1mhcli ida accept-eula[0m [[1;36mOPTIONS[0m] [[1;36mPATH[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli ida add
Add an IDA Pro instance.
Without --auto: Add a specific IDA instance by name and path. With --auto: Discover and interactively add standard IDA installations.
NAME: Logical name for the IDA instance PATH: Base path to the IDA installation directory
Usage:
[1mhcli ida add[0m [[1;36mOPTIONS[0m] [[1;36mNAME[0m] [[1;36mPATH[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--auto |
boolean | Automatically discover standard IDA installations | False |
--help |
boolean | Show this message and exit. | False |
hcli ida install
Installs IDA unattended.
The --download-id option supports tags for simplified version specification: - 'category:version' (e.g., 'ida-pro:latest') - OS is auto-detected - 'category:version:os' (e.g., 'ida-pro:9.2:x64linux') - explicit OS
If install_dir is /tmp/myida, the ida binary will be located: - on Windows: /tmp/myida/ida - on Linux: /tmp/myida/ida - on Mac: /tmp/myida/Contents/MacOS/ida
Usage:
[1mhcli ida install[0m [[1;36mOPTIONS[0m] [[1;36mINSTALLER[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--create-python-environment |
boolean | After installing IDA, create a virtual environment for its Python at $IDAUSR/venv (see ida python create-environment). |
False |
--yes, -y |
boolean | Auto-accept confirmation prompts | False |
--dry-run |
boolean | Show what would be done without actually installing | False |
--set-default / --no-set-default |
boolean | Mark this IDA installation as the default | True |
-a, --accept-eula / -A, --no-accept-eula |
boolean | Accept EULA | True |
-i, --install-dir |
text | Install dir | None |
-l, --license-id |
text | License ID (e.g., 96-0000-0000-01) | None |
-d, --download-id |
text | Full installer asset key, or tag (e.g., 'ida-pro:latest', 'ida-essential:9.2') | None |
--help |
boolean | Show this message and exit. | False |
hcli ida list
List all registered IDA Pro instances.
Usage:
[1mhcli ida list[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli ida open
Open an ida:// link in the appropriate IDA instance.
For IDA 9.4+, this command finds a running IDA instance with the specified IDB and navigates to the location in the URI. If no matching instance is found, IDA is launched and the link is opened after startup.
For older IDA versions, this command launches IDA with the IDB file. Navigation to specific locations requires IDA 9.4+ with IPC support.
Use --list to show running IDA instances (requires IDA 9.4+ IPC).
Example URIs: ida://malwares/trojan1.i64/functions?rva=0x1000 (named source) ida://malwares/trojan1.i64 (named source, resource defaults to functions) ida:///myfile.i64/functions?rva=0x1000 (relative: searches all sources) ida:///myfile.i64 (relative, resource defaults to functions) ida:///myfile.i64/addresses?rva=0x0 (open IDB and position at beginning) ida:///functions?rva=0x1000 (relative: sent to the only running instance)
KE URLs (download from KE server and launch IDA): ida://host:port/api/v1/buckets/{bucket}/assets/{key}
Usage:
[1mhcli ida open[0m [[1;36mOPTIONS[0m] [[1;36mURI[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--list |
boolean | List running IDA instances with IPC support (IDA 9.4+) | False |
--no-launch |
boolean | Don't auto-launch IDA if no matching instance is found | False |
--timeout |
float | Timeout in seconds for IDA startup (default: 120) | 120.0 |
--skip-analysis |
boolean | Don't wait for auto-analysis to complete after launching IDA | False |
--help |
boolean | Show this message and exit. | False |
hcli ida protocol
Manage ida:// protocol handlers.
Usage:
[1mhcli ida protocol[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- register: Set up hcli protocol handlers for ida:// URLs.
- unregister: Remove hcli protocol handlers for ida:// URLs.
hcli ida protocol register
Set up hcli protocol handlers for ida:// URLs.
This command registers hcli as the handler for ida:// URLs on your system, allowing web browsers and other applications to automatically open IDB links with hcli.
The setup process varies by platform: - macOS: Creates an AppleScript application and registers with Launch Services - Windows: Adds registry entries for the ida:// protocol - Linux: Creates a desktop entry and registers with xdg-mime
Usage:
[1mhcli ida protocol register[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--force |
boolean | Force reinstall even if already configured | False |
--help |
boolean | Show this message and exit. | False |
hcli ida protocol unregister
Remove hcli protocol handlers for ida:// URLs.
This command removes hcli as the handler for ida:// URLs on your system.
The removal process varies by platform: - macOS: Removes the AppleScript application and unregisters from Launch Services - Windows: Removes registry entries for the ida:// protocol - Linux: Removes the desktop entry and unregisters from xdg-mime
Usage:
[1mhcli ida protocol unregister[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli ida python
Use the Python environment that IDA loads.
Usage:
[1mhcli ida python[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--no-python-environment-check |
boolean | Do not warn when IDA's Python environment differs from the recommended setup. | False |
--help |
boolean | Show this message and exit. | False |
Subcommands
- create-environment: Create a virtual environment for IDA's Python and configure IDA to use it.
- doctor: Check IDA's Python environment against the recommended setup.
- exec: Run IDA's Python interpreter, passing through all arguments.
- explain-environment: Show how the current IDA installation and Python version are detected. (experimental)
- find-script: Show the path of a script installed in IDA's Python environment.
- run-script: Run a script installed in IDA's Python environment.
hcli ida python create-environment
Create a virtual environment for IDA's Python and configure IDA to use it.
The environment is created at $IDAUSR/venv with the Python version that idapyswitch registered for IDA, and seeded with pip. Existing directories are never modified or replaced.
When plugins with Python dependencies are already installed, their dependencies are reinstalled into the new environment. Pass --no-reinstall-plugins to skip this step.
HCLI shows a plan of the changes it will make. In an interactive terminal it asks for confirmation; in scripts and CI it applies them automatically. Pass --no-configure-env-var to skip this step. In a GitHub Actions job, HCLI also adds the variable to $GITHUB_ENV, so the later steps of the job use the environment.
Usage:
[1mhcli ida python create-environment[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--path |
path | Where to create the virtual environment (default: $IDAUSR/venv). | None |
--python-version |
text | Python version to use when idat is not available. IDA's own version wins when known. | None |
--no-configure-env-var |
boolean | Do not set IDAPYTHON_VENV_EXECUTABLE. Only create the virtual environment. | False |
--no-reinstall-plugins |
boolean | Skip reinstalling Python dependencies for existing plugins into the new environment. Use this for offline setups or when you plan to reinstall plugins manually. | False |
--json |
boolean | Output the result as JSON. | False |
--help |
boolean | Show this message and exit. | False |
hcli ida python doctor
Check IDA's Python environment against the recommended setup.
The recommended setup is a virtual environment with pip, selected by IDAPYTHON_VENV_EXECUTABLE. Its Python version must match the one that idapyswitch registered for IDA. Each problem comes with a fix.
Exits with status 1 when a problem prevents installing plugin dependencies.
Usage:
[1mhcli ida python doctor[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--json |
boolean | Output the report as JSON. | False |
--help |
boolean | Show this message and exit. | False |
hcli ida python exec
Run IDA's Python interpreter, passing through all arguments.
Without arguments, this starts an interactive interpreter. HCLI exits with the status of the interpreter.
Examples: hcli ida python exec -m pip install requests hcli ida python exec -c "import requests; print('ok')" hcli ida python exec script.py --flag hcli ida python exec --version
--help here describes this command; pass it to the interpreter with --:
hcli ida python exec -- --help
Usage:
[1mhcli ida python exec[0m [[1;36mOPTIONS[0m] [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli ida python explain-environment
Show how the current IDA installation and Python version are detected. (experimental)
Usage:
[1mhcli ida python explain-environment[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--json |
boolean | output machine-readable JSON | False |
--help |
boolean | Show this message and exit. | False |
hcli ida python find-script
Show the path of a script installed in IDA's Python environment.
NAME: name of the script, like speakeasy
Prints nothing and exits non-zero when the script isn't installed.
Usage:
[1mhcli ida python find-script[0m [[1;36mOPTIONS[0m] [1;36mNAME[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli ida python run-script
Run a script installed in IDA's Python environment.
NAME: name of the script, like speakeasy
ARGS: arguments passed through to the script
HCLI exits with the status of the script.
Examples: hcli ida python run-script speakeasy -t sample.exe hcli ida python run-script speakeasy --help
Usage:
[1mhcli ida python run-script[0m [[1;36mOPTIONS[0m] [1;36mNAME[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli ida remove
Remove an IDA Pro instance.
NAME: Name of the IDA instance to remove (required unless using --all)
Usage:
[1mhcli ida remove[0m [[1;36mOPTIONS[0m] [[1;36mNAME[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--all |
boolean | Remove all registered IDA instances | False |
--help |
boolean | Show this message and exit. | False |
hcli ida set-default
Set or show the default IDA installation directory.
Deprecated: use 'hcli ida switch' instead.
Usage:
[1mhcli ida set-default[0m [[1;36mOPTIONS[0m] [[1;36mPATH[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli ida source
Manage named sources for IDB file lookup.
Usage:
[1mhcli ida source[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- add: Add a named source for IDB file lookup.
- list: List configured sources.
- remove: Remove a named source.
hcli ida source add
Add a named source for IDB file lookup.
NAME: Source name (lowercase alphanumeric + hyphens), used in ida:// URLs. PATH: Directory to search for IDB files.
Usage:
[1mhcli ida source add[0m [[1;36mOPTIONS[0m] [1;36mNAME[0m [1;36mPATH[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--force |
boolean | Overwrite if name already exists | False |
--help |
boolean | Show this message and exit. | False |
hcli ida source list
List configured sources.
Usage:
[1mhcli ida source list[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli ida source remove
Remove a named source.
NAME: Source name to remove (as shown in 'hcli ida source list').
Usage:
[1mhcli ida source remove[0m [[1;36mOPTIONS[0m] [1;36mNAME[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli ida switch
Switch the default IDA Pro instance.
NAME: Name of the IDA instance to set as default (optional - will prompt if not provided)
Usage:
[1mhcli ida switch[0m [[1;36mOPTIONS[0m] [[1;36mNAME[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli license
Manage IDA licenses.
Usage:
[1mhcli license[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- get: Download license files with optional filtering.
- install: Install a license file to an IDA Pro installation directory.
- list: List available licenses with rich formatting.
hcli license get
Download license files with optional filtering.
Usage:
[1mhcli license get[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-i, --id |
text | License ID (e.g., 96-0000-0000-01) | None |
-p, --plan |
choice (subscription | legacy) |
Plan type: subscription or legacy | None |
-t, --type |
text | License type (e.g., IDAPRO, IDAHOME, LICENSE_SERVER) | None |
-a, --all |
boolean | Get all matching licenses | False |
--output-dir |
text | Output directory for license files | ./ |
--include-legacy-license |
text | Also download the IDA 9.0 license format (hexlic_v90), needed by IDA before 9.3 | False |
--help |
boolean | Show this message and exit. | False |
hcli license install
Install a license file to an IDA Pro installation directory.
Usage:
[1mhcli license install[0m [[1;36mOPTIONS[0m] [1;36mFILE[0m [[1;36mIDA_DIR[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli license list
List available licenses with rich formatting.
Usage:
[1mhcli license list[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-p, --plan |
choice (subscription | legacy) |
Filter by plan type: subscription or legacy | None |
--help |
boolean | Show this message and exit. | False |
hcli login
Log in to the Hex-Rays portal and create new credentials.
Usage:
[1mhcli login[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-f, --force |
boolean | Force account selection. | False |
-n, --name |
text | Custom name for the credentials | None |
--help |
boolean | Show this message and exit. | False |
hcli logout
Log out and remove stored credentials.
Usage:
[1mhcli logout[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-n, --name |
text | Name of specific credentials to remove | None |
-a, --all |
boolean | Remove all credentials | False |
--help |
boolean | Show this message and exit. | False |
hcli mcp
IDA MCP integrations for AI coding agents.
Usage:
[1mhcli mcp[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- install: Install IDA MCP for Claude, Codex, Copilot, Pi, or Oh My Pi.
hcli mcp install
Install IDA MCP for Claude, Codex, Copilot, Pi, or Oh My Pi.
Usage:
[1mhcli mcp install[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin
Manage IDA Pro plugins.
Usage:
[1mhcli plugin[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--no-python-environment-check |
boolean | Install Python dependencies even when IDA's Python environment fails the health check (see ida python doctor). |
False |
--help |
boolean | Show this message and exit. | False |
Subcommands
- bundle: Manage plugin bundles for offline installation.
- config: Manage plugin configuration settings.
- install: Install a plugin from a repository, local directory, local .zip file, or URL.
- lint: Lint an IDA plugin directory, archive (.zip file), or HTTPS URL.
- repo: Manage plugin repositories.
- search: Search for plugins by name, keyword, category, or author.
- status: Show installed plugins and their upgrade status.
- uninstall: Remove an installed plugin.
- upgrade: Upgrade an installed plugin to the latest compatible version.
hcli plugin bundle
Manage plugin bundles for offline installation.
Usage:
[1mhcli plugin bundle[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- create: Create a plugin bundle from plugin specs, local directories, and/or ZIPs.
- info: Show plugin bundle metadata.
hcli plugin bundle create
Create a plugin bundle from plugin specs, local directories, and/or ZIPs.
Usage:
[1mhcli plugin bundle create[0m [[1;36mOPTIONS[0m] [1;36mPLUGIN_SPECS[0m...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--path |
path | output archive path | _required |
--platform |
text | target platform: 'current', 'all', or a name like 'linux', 'windows', 'macos-arm64' (repeatable) | None |
--python |
text | target Python version: 'current', 'all', or a version like '3.12', '3.13' (repeatable) | None |
--repo |
text | plugin repository for resolving specs | None |
--help |
boolean | Show this message and exit. | False |
hcli plugin bundle info
Show plugin bundle metadata.
Usage:
[1mhcli plugin bundle info[0m [[1;36mOPTIONS[0m] [1;36mBUNDLE_PATH[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin config
Manage plugin configuration settings.
Usage:
[1mhcli plugin config[0m [[1;36mOPTIONS[0m] [1;36mPLUGIN_NAME[0m [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- del: Delete a plugin configuration setting.
- export: Export plugin configuration settings as JSON.
- get: Get a plugin configuration setting.
- import: Import plugin configuration settings from JSON.
- list: List all configuration settings for a plugin.
- set: Set a plugin configuration setting.
- setup: Interactively re-configure all plugin settings.
hcli plugin config PLUGIN_NAME del
Delete a plugin configuration setting.
Usage:
[1mhcli plugin config PLUGIN_NAME del[0m [[1;36mOPTIONS[0m] [1;36mKEY[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin config PLUGIN_NAME export
Export plugin configuration settings as JSON.
Usage:
[1mhcli plugin config PLUGIN_NAME export[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin config PLUGIN_NAME get
Get a plugin configuration setting.
Usage:
[1mhcli plugin config PLUGIN_NAME get[0m [[1;36mOPTIONS[0m] [1;36mKEY[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin config PLUGIN_NAME import
Import plugin configuration settings from JSON.
Usage:
[1mhcli plugin config PLUGIN_NAME import[0m [[1;36mOPTIONS[0m] [[1;36mJSON_INPUT[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin config PLUGIN_NAME list
List all configuration settings for a plugin.
Usage:
[1mhcli plugin config PLUGIN_NAME list[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin config PLUGIN_NAME set
Set a plugin configuration setting.
Usage:
[1mhcli plugin config PLUGIN_NAME set[0m [[1;36mOPTIONS[0m] [1;36mKEY[0m [1;36mVALUE[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin config PLUGIN_NAME setup
Interactively re-configure all plugin settings.
Usage:
[1mhcli plugin config PLUGIN_NAME setup[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin install
Install a plugin from a repository, local directory, local .zip file, or URL.
Usage:
[1mhcli plugin install[0m [[1;36mOPTIONS[0m] [1;36mPLUGIN[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-e, --editable |
boolean | Install a local plugin directory by symlinking it into $IDAUSR/plugins/. Edits to the source tree take effect immediately on the next plugin reload. | False |
--config |
text | Configuration setting in key=value format. Prefix with a component or dependency name to target it: name.key=value. Use true/false for booleans. | None |
--no-build-isolation |
boolean | Disable pip build isolation when installing Python dependencies | False |
-U, --upgrade |
boolean | Upgrade the plugin when it is already installed, instead of failing. Does nothing when the installed version is already up to date. | False |
--help |
boolean | Show this message and exit. | False |
hcli plugin lint
Lint an IDA plugin directory, archive (.zip file), or HTTPS URL.
Usage:
[1mhcli plugin lint[0m [[1;36mOPTIONS[0m] [1;36mPATH[0m|[1;36mURL[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin repo
Manage plugin repositories.
Usage:
[1mhcli plugin repo[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- add: Add a plugin repository.
- list: List the configured plugin repositories.
- remove: Remove a plugin repository.
- set-default: Set the repository used for references with no repo/ prefix.
- snapshot: Create a snapshot of the repository.
hcli plugin repo add
Add a plugin repository.
Usage:
[1mhcli plugin repo add[0m [[1;36mOPTIONS[0m] [1;36mNAME[0m [1;36mURL[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin repo list
List the configured plugin repositories.
Usage:
[1mhcli plugin repo list[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin repo remove
Remove a plugin repository.
Usage:
[1mhcli plugin repo remove[0m [[1;36mOPTIONS[0m] [1;36mNAME[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin repo set-default
Set the repository used for references with no repo/ prefix.
Usage:
[1mhcli plugin repo set-default[0m [[1;36mOPTIONS[0m] [1;36mNAME[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin repo snapshot
Create a snapshot of the repository.
Usage:
[1mhcli plugin repo snapshot[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
hcli plugin search
Search for plugins by name, keyword, category, or author.
Usage:
[1mhcli plugin search[0m [[1;36mOPTIONS[0m] [[1;36mQUERY[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--json |
boolean | output machine-readable JSON | False |
--help |
boolean | Show this message and exit. | False |
hcli plugin status
Show installed plugins and their upgrade status.
If one or more PLUGINS are given, show status for just those plugins, and exit with a non-zero status if any of them isn't installed.
Usage:
[1mhcli plugin status[0m [[1;36mOPTIONS[0m] [[1;36mPLUGINS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--skip-upgrade-check |
boolean | skip the per-plugin upgrade check against the plugin repository | False |
--json |
boolean | output machine-readable JSON | False |
--show-components |
boolean | expand plugin suites to show their bundled components | False |
--help |
boolean | Show this message and exit. | False |
hcli plugin uninstall
Remove an installed plugin.
Usage:
[1mhcli plugin uninstall[0m [[1;36mOPTIONS[0m] [1;36mPLUGIN[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Confirm all prompts automatically. | False |
--help |
boolean | Show this message and exit. | False |
hcli plugin upgrade
Upgrade an installed plugin to the latest compatible version.
Usage:
[1mhcli plugin upgrade[0m [[1;36mOPTIONS[0m] [1;36mPLUGIN[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--no-build-isolation |
boolean | Disable pip build isolation when installing Python dependencies | False |
--help |
boolean | Show this message and exit. | False |
hcli share
Share files with Hex-Rays.
Usage:
[1mhcli share[0m [[1;36mOPTIONS[0m] [1;36mCOMMAND[0m [[1;36mARGS[0m]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- delete: Delete shared file by code.
- get: Download a shared file using its shortcode.
- list: List and manage your shared files.
- put: Upload a shared file.
hcli share delete
Delete shared file by code.
Usage:
[1mhcli share delete[0m [[1;36mOPTIONS[0m] [1;36mSHORTCODE[0m...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-f, --force |
boolean | Skip confirmation prompt | False |
--help |
boolean | Show this message and exit. | False |
hcli share get
Download a shared file using its shortcode.
Usage:
[1mhcli share get[0m [[1;36mOPTIONS[0m] [1;36mSHORTCODE[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-o, --output-dir |
path | Output directory (default: current directory) | None |
-O, --output-file |
path | Output file path (conflicts with --output-dir) | None |
-f, --force |
boolean | Overwrite existing files | False |
--help |
boolean | Show this message and exit. | False |
hcli share list
List and manage your shared files.
Usage:
[1mhcli share list[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--limit |
integer | Maximum number of files to display | 100 |
--offset |
integer | Offset for pagination | 0 |
--interactive / --no-interactive |
boolean | Enable interactive mode for file operations | True |
--help |
boolean | Show this message and exit. | False |
hcli share put
Upload a shared file.
Usage:
[1mhcli share put[0m [[1;36mOPTIONS[0m] [1;36mPATH[0m
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-a, --acl |
choice (private | authenticated | domain) |
Access control level (private, authenticated, domain) | None |
-c, --code |
text | Upload a new version for an existing code | None |
-f, --force |
boolean | Upload a new version for an existing code | False |
--help |
boolean | Show this message and exit. | False |
hcli update
Check for hcli updates.
Usage:
[1mhcli update[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-f, --force |
boolean | Force update. | False |
--auto-install |
boolean | Automatically install update if available. | False |
--include-prereleases |
boolean | Include pre-release versions when checking GitHub (for binary version only). | False |
--help |
boolean | Show this message and exit. | False |
hcli whoami
Display the currently logged-in user.
Usage:
[1mhcli whoami[0m [[1;36mOPTIONS[0m]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |