# IDA HCLI
change #1 : chore
change #2 : fix
change #3 : feature
A modern command-line interface for managing IDA Pro licenses, plugins, ...
[](https://badge.fury.io/py/ida-hcli)
[](https://opensource.org/licenses/MIT)
[](https://www.python.org/downloads/)
# Documentation
See [https://hcli.docs.hex-rays.com/](hcli.docs.hex-rays.com/)
## Contributing
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to:
- Report bugs and suggest features
- Submit pull requests with proper testing
- Set up your development environment with Hatch
- Generate and update documentation automatically
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Issues and Support
- **Bug Reports & Feature Requests**: [GitHub Issues](https://github.com/HexRaysSA/ida-hcli/issues)
- **Questions & Discussions**: [Discussions](https://community.hex-rays.com/)
- **Documentation**: Auto-generated from source code at build time
- **Commercial Support**: Contact support@hex-rays.com
- **Hex-Rays Website**: [hex-rays.com](https://hex-rays.com/)
## Development
### Prerequisites
- Python 3.10 or higher
- [uv](https://docs.astral.sh/uv/) package manager
### Setup
```bash
# 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
```bash
# Install with development dependencies
uv sync --extra dev
# Build package
uv build
# Run development tools
uv run ruff format
uv run ruff check --fix
uv run ruff check --select I --fix
```
### Documentation
Documentation is **automatically generated** from source code:
```bash
# 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
```bash
# Run tests
uv run pytest
# Test CLI commands
uv run hcli whoami
uv run hcli plugin list
```
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed development guidelines.
Raw data
{
"_id": null,
"home_page": null,
"name": "ida-hcli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ida, ida-pro, reverse-engineering, disassembler, binary-analysis, malware-analysis, security",
"author": null,
"author_email": "Hex-Rays SA <support@hex-rays.com>",
"download_url": "https://files.pythonhosted.org/packages/eb/fb/b344259386e2e880c19ba2fa0b31a426719767a2423af25903605b35f28e/ida_hcli-0.5.5.tar.gz",
"platform": null,
"description": "# IDA HCLI\n\n\n\nchange #1 : chore \nchange #2 : fix \nchange #3 : feature \n\nA modern command-line interface for managing IDA Pro licenses, plugins, ...\n\n[](https://badge.fury.io/py/ida-hcli)\n[](https://opensource.org/licenses/MIT)\n[](https://www.python.org/downloads/)\n\n# Documentation\n\nSee [https://hcli.docs.hex-rays.com/](hcli.docs.hex-rays.com/)\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to:\n\n- Report bugs and suggest features\n- Submit pull requests with proper testing\n- Set up your development environment with Hatch\n- Generate and update documentation automatically\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Issues and Support\n\n- **Bug Reports & Feature Requests**: [GitHub Issues](https://github.com/HexRaysSA/ida-hcli/issues)\n- **Questions & Discussions**: [Discussions](https://community.hex-rays.com/)\n- **Documentation**: Auto-generated from source code at build time\n- **Commercial Support**: Contact support@hex-rays.com\n- **Hex-Rays Website**: [hex-rays.com](https://hex-rays.com/)\n\n## Development\n\n### Prerequisites\n\n- Python 3.10 or higher\n- [uv](https://docs.astral.sh/uv/) package manager\n\n### Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/HexRaysSA/ida-hcli.git\ncd ida-hcli\n\n# Install dependencies\nuv sync\n\n# Run in development mode\nuv run hcli --help\n```\n\n### Build System\n\n```bash\n# Install with development dependencies\nuv sync --extra dev \n\n# Build package\nuv build \n\n# Run development tools\nuv run ruff format\nuv run ruff check --fix\nuv run ruff check --select I --fix\n```\n\n### Documentation\n\nDocumentation is **automatically generated** from source code:\n\n```bash\n# Build documentation\nuv run mkdocs build\n\n# Serve documentation locally\nuv run mkdocs serve\n\n# Documentation includes:\n# - CLI commands (from Click help text)\n# - API reference (from Python docstrings)\n# - Usage examples (auto-generated)\n```\n\n### Testing\n\n```bash\n# Run tests\nuv run pytest\n\n# Test CLI commands\nuv run hcli whoami\nuv run hcli plugin list\n```\n\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for detailed development guidelines.\n",
"bugtrack_url": null,
"license": null,
"summary": "HCLI - Hex-Rays CLI Utility",
"version": "0.5.5",
"project_urls": {
"Homepage": "https://hex-rays.com/",
"Issues": "https://github.com/HexRaysSA/ida-hcli/issues",
"Repository": "https://github.com/HexRaysSA/ida-hcli"
},
"split_keywords": [
"ida",
" ida-pro",
" reverse-engineering",
" disassembler",
" binary-analysis",
" malware-analysis",
" security"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f65b6ee1bd3629b2b1c58b4b96f1c874e2d0bea56ca977670534f7537edbc36a",
"md5": "201b31f378feee15f1bd6d7266e41ba1",
"sha256": "477a1dfd08cdb6e39714713a0b64915bdcbdf58741bab428a494bf657f7abc00"
},
"downloads": -1,
"filename": "ida_hcli-0.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "201b31f378feee15f1bd6d7266e41ba1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 87228,
"upload_time": "2025-08-14T22:58:46",
"upload_time_iso_8601": "2025-08-14T22:58:46.991401Z",
"url": "https://files.pythonhosted.org/packages/f6/5b/6ee1bd3629b2b1c58b4b96f1c874e2d0bea56ca977670534f7537edbc36a/ida_hcli-0.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ebfbb344259386e2e880c19ba2fa0b31a426719767a2423af25903605b35f28e",
"md5": "3e8322fe0847ba63924e3c779d9c6251",
"sha256": "96a0c188be6283ec43090ecc7daf57135f78cbbb035a7c819393b12517a68072"
},
"downloads": -1,
"filename": "ida_hcli-0.5.5.tar.gz",
"has_sig": false,
"md5_digest": "3e8322fe0847ba63924e3c779d9c6251",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 62942,
"upload_time": "2025-08-14T22:58:48",
"upload_time_iso_8601": "2025-08-14T22:58:48.241762Z",
"url": "https://files.pythonhosted.org/packages/eb/fb/b344259386e2e880c19ba2fa0b31a426719767a2423af25903605b35f28e/ida_hcli-0.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-14 22:58:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "HexRaysSA",
"github_project": "ida-hcli",
"github_not_found": true,
"lcname": "ida-hcli"
}
JSON
