IDA HCLI
A modern command-line interface for managing IDA Pro licenses, downloads, ...
Documentation
See https://hcli.docs.hex-rays.com/
Contributing
HCLI is under heavy active development by our team. We are not accepting external contributions at this time due to:
- Rapid development and frequent breaking changes
- Tight integration requirements with our proprietary IDA Pro workflows
- Internal roadmap priorities and architectural decisions
However feel free to report bugs or suggest features via Issues
For our internal team, please see our Contributing Guidelines for development setup and workflow.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Issues and Support
- Bug Reports & Feature Requests: GitHub Issues
- Questions & Discussions: Discussions
- Documentation: Auto-generated from source code at build time
- Commercial Support: Contact support@hex-rays.com
- Hex-Rays Website: hex-rays.com
Development
Prerequisites
- Python 3.10 or higher
- uv package manager
Setup
# Clone the repository
git clone https://github.com/HexRaysSA/ida-hcli.git
cd ida-hcli
# Install dependencies
uv sync
# Run in development mode
uv run hcli --help
Build System
# Install with development dependencies
uv sync --extra dev
# Build package
uv build
# Run development tools
uvx ruff format
uvx ruff check --fix
uvx ruff check --select I --fix
uvx mypy --check-untyped-defs src/ tests/ --exclude tests/data/ --disable-error-code=import-untyped --disable-error-code=import-not-found
Documentation
Documentation is automatically generated from source code:
# Build documentation
uv run mkdocs build
# Serve documentation locally
uv run mkdocs serve
# Documentation includes:
# - CLI commands (from Click help text)
# - API reference (from Python docstrings)
# - Usage examples (auto-generated)
Testing
# Run tests
uv run pytest
# Test CLI commands
uv run hcli whoami
uv run hcli plugin list
See CONTRIBUTING.md for detailed development guidelines.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ida_hcli-0.18.6.tar.gz.
File metadata
- Download URL: ida_hcli-0.18.6.tar.gz
- Upload date:
- Size: 185.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5856968c2eecf9bb3bbca3ca2b6e22e6e90d1e4f5b40911868632d7927aa5466
|
|
| MD5 |
cf176168caeed729752b6dff49de7106
|
|
| BLAKE2b-256 |
84e26d42b44b305cb013404bf687047252d60c85c142d61ee0cb2e2843d238da
|
File details
Details for the file ida_hcli-0.18.6-py3-none-any.whl.
File metadata
- Download URL: ida_hcli-0.18.6-py3-none-any.whl
- Upload date:
- Size: 232.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84d8d969550a39fcc22dbb937e0854d1db95d70784136f0c19f16891d1f65475
|
|
| MD5 |
e6ba9ce8e0e4b9c13d09e73f669f2e61
|
|
| BLAKE2b-256 |
3ba7c2b18017f08f46f48b13163fd209716d59e2cf7af6a179feda17f4160a98
|
