invctl 0.1.0__tar.gz

invctl-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+    tags: ["v*"]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+  lint:
+    name: Lint (ruff + mypy)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      - name: ruff check
+        run: ruff check .
+      - name: mypy
+        run: mypy invctl/
+
+  test:
+    name: Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      - name: Run tests
+        run: pytest --cov=invctl --cov-report=term-missing --cov-report=xml
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.12'
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+
+  publish:
+    name: Publish to PyPI + GitHub Release
+    needs: [lint, test]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    permissions:
+      id-token: write  # OIDC Trusted Publisher
+      contents: write  # create GitHub Release
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install hatch
+        run: pip install hatch
+      - name: Build
+        run: hatch build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "${{ github.ref_name }}" dist/* \
+            --title "${{ github.ref_name }}" \
+            --notes-from-tag

invctl-0.1.0/.gitignore

@@ -0,0 +1,41 @@
+# ── Python ────────────────────────────────────────────────────────────────
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+*.so
+*.egg
+*.egg-info/
+.eggs/
+dist/
+build/
+MANIFEST
+
+# ── Virtual environments ──────────────────────────────────────────────────
+.venv/
+venv/
+env/
+ENV/
+
+# ── uv ────────────────────────────────────────────────────────────────────
+.uv/
+
+# ── Testing ───────────────────────────────────────────────────────────────
+.pytest_cache/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+.tox/
+test-results/
+junit.xml
+
+# ── Type checking & linting ───────────────────────────────────────────────
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.ruff_cache/
+
+# ── Distribution ──────────────────────────────────────────────────────────
+*.tar.gz
+*.whl

invctl-0.1.0/LICENSE

@@ -0,0 +1,192 @@
+Copyright 2026 Alexis Frère
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+---
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a result
+      of this License or out of the use or inability to use the Work
+      (including but not limited to damages for loss of goodwill, work
+      stoppage, computer failure or malfunction, or any and all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

invctl-0.1.0/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.4
+Name: invctl
+Version: 0.1.0
+Summary: Infrastructure Inventory Control for Proxmox VE
+Author-email: Alexis Frère <frere.alexis974@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: devops,infrastructure,inventory,ops,proxmox
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.11
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: proxmoxer>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.12.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Requires-Dist: types-requests>=2.31.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# invctl — Infrastructure Inventory Control
+
+[![CI](https://github.com/frere-alexis/invctl/actions/workflows/ci.yml/badge.svg)](https://github.com/frere-alexis/invctl/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/invctl)](https://pypi.org/project/invctl/)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+> **Reverse-engineer an undocumented Proxmox VE infrastructure in seconds.**
+
+`invctl` connects to the Proxmox API and produces a structured, exportable inventory of every
+layer of the infrastructure — nodes, VMs, containers, storage, networking, backups, users, and
+firewall rules. Designed for ops engineers inheriting a cluster with no runbooks.
+
+The author is a contributor to [proxmoxer](https://github.com/proxmoxer/proxmoxer), the
+underlying Proxmox API client library.
+
+---
+
+## Features
+
+| Section | What's collected |
+|---|---|
+| **Cluster** | Name, quorum status, HA state and groups |
+| **Nodes** | Hardware (CPU model, sockets, cores), memory, kernel, PVE version, subscription |
+| **Virtual Machines** | Config (CPU, RAM, disks, networks, BIOS, agent), runtime stats, snapshots, tags |
+| **LXC Containers** | Config (CPU, RAM, swap, rootfs, mountpoints, networks), runtime stats, snapshots, tags |
+| **Storage** | All backends (dir/nfs/cifs/lvmthin/zfspool/ceph/…), content types, per-node usage |
+| **Network** | Bridges, bonds, VLANs per node with IP/CIDR, ports, STP, VLAN-aware flag |
+| **Backups** | All vzdump jobs: schedule, targets, mode, retention policy |
+| **Users & Access** | Users, groups, roles, ACLs, authentication realms |
+| **Firewall** | Cluster policy, security groups, per-node and per-VM/CT rules |
+| **diff** | Compare two snapshots: added/removed VMs & CTs, config changes, storage drift, user changes |
+
+---
+
+## Prerequisites
+
+### Proxmox API token (recommended)
+
+1. Go to **Datacenter → Permissions → API Tokens** in the web UI
+2. Click **Add** — select the user, set a token ID, uncheck **Privilege Separation** for full
+   read access (or scope it to `VM.Audit`, `Datastore.Audit`, etc. for least privilege)
+3. Copy the token secret — shown only once
+
+### Required API privileges (read-only scan)
+
+| Privilege | Used by |
+|---|---|
+| `VM.Audit` | VMs, containers |
+| `Datastore.Audit` | Storage |
+| `Sys.Audit` | Nodes, network |
+| `Permissions.Read` | Users, ACLs, roles |
+
+---
+
+## Install
+
+```bash
+pip install invctl
+```
+
+With [uv](https://github.com/astral-sh/uv):
+
+```bash
+uv tool install invctl
+```
+
+---
+
+## Configuration
+
+All CLI flags have environment variable equivalents:
+
+| Env var | Flag | Description |
+|---|---|---|
+| `PROXMOX_HOST` | `--host` | Proxmox hostname or IP |
+| `PROXMOX_TOKEN_ID` | `--token-id` | API token ID (`user@realm!tokenname`) |
+| `PROXMOX_TOKEN_SECRET` | `--token-secret` | API token secret |
+| `PROXMOX_USER` | `--user` | Username for password auth |
+| `PROXMOX_PASSWORD` | `--password` | Password for password auth |
+
+Store credentials in a `.env` file and source it:
+
+```bash
+# .env
+PROXMOX_HOST=pve.example.com
+PROXMOX_TOKEN_ID=root@pam!invctl
+PROXMOX_TOKEN_SECRET=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+```
+
+```bash
+source .env && invctl scan
+```
+
+---
+
+## Usage
+
+### Full scan to JSON
+
+```bash
+invctl scan --host pve.example.com \
+  --token-id root@pam!invctl \
+  --token-secret <secret>
+```
+
+### Save a dated snapshot
+
+```bash
+invctl scan --output json --file "inventory-$(date +%Y%m%d).json"
+```
+
+### HTML report
+
+```bash
+invctl scan --output html --file report.html && open report.html
+```
+
+### Markdown report
+
+```bash
+invctl scan --output markdown --file INFRA.md
+```
+
+### Collect specific sections only
+
+```bash
+invctl scan --sections vms,containers
+invctl scan --sections users,firewall --output markdown
+```
+
+### Diff two snapshots
+
+```bash
+invctl diff inventory-20240101.json inventory-20240201.json
+invctl diff old.json new.json --output json | jq '.vms.added'
+invctl diff old.json new.json --output markdown
+```
+
+### Self-signed certificate
+
+```bash
+invctl scan --host 192.168.1.10 --no-verify-ssl
+```
+
+### CLI reference
+
+```
+invctl scan [OPTIONS]
+
+  --host TEXT                       [env: PROXMOX_HOST]
+  --token-id TEXT                   [env: PROXMOX_TOKEN_ID]
+  --token-secret TEXT               [env: PROXMOX_TOKEN_SECRET]
+  --user TEXT                       [env: PROXMOX_USER]
+  --password TEXT                   [env: PROXMOX_PASSWORD]
+  --port INT                        Default: 8006
+  --no-verify-ssl
+  --output [json|html|markdown]     Default: json
+  --file PATH
+  --sections TEXT                   cluster,nodes,vms,containers,
+                                    storage,network,backups,users,firewall
+  --pretty / --no-pretty            Default: --pretty
+
+invctl diff FILE1 FILE2 [OPTIONS]
+
+  --output [text|json|markdown]     Default: text
+```
+
+---
+
+## Contributing
+
+Contributions are welcome — open an issue or pull request on GitHub.
+
+For a guide on how the codebase is structured, how the CI works, and how to add new collectors
+or exporters, see [ARCHITECTURE.md](ARCHITECTURE.md).
+
+Please make sure `ruff check .` and `mypy invctl/` pass before submitting a PR.

invctl-0.1.0/README.md

@@ -0,0 +1,179 @@
+# invctl — Infrastructure Inventory Control
+
+[![CI](https://github.com/frere-alexis/invctl/actions/workflows/ci.yml/badge.svg)](https://github.com/frere-alexis/invctl/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/invctl)](https://pypi.org/project/invctl/)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+> **Reverse-engineer an undocumented Proxmox VE infrastructure in seconds.**
+
+`invctl` connects to the Proxmox API and produces a structured, exportable inventory of every
+layer of the infrastructure — nodes, VMs, containers, storage, networking, backups, users, and
+firewall rules. Designed for ops engineers inheriting a cluster with no runbooks.
+
+The author is a contributor to [proxmoxer](https://github.com/proxmoxer/proxmoxer), the
+underlying Proxmox API client library.
+
+---
+
+## Features
+
+| Section | What's collected |
+|---|---|
+| **Cluster** | Name, quorum status, HA state and groups |
+| **Nodes** | Hardware (CPU model, sockets, cores), memory, kernel, PVE version, subscription |
+| **Virtual Machines** | Config (CPU, RAM, disks, networks, BIOS, agent), runtime stats, snapshots, tags |
+| **LXC Containers** | Config (CPU, RAM, swap, rootfs, mountpoints, networks), runtime stats, snapshots, tags |
+| **Storage** | All backends (dir/nfs/cifs/lvmthin/zfspool/ceph/…), content types, per-node usage |
+| **Network** | Bridges, bonds, VLANs per node with IP/CIDR, ports, STP, VLAN-aware flag |
+| **Backups** | All vzdump jobs: schedule, targets, mode, retention policy |
+| **Users & Access** | Users, groups, roles, ACLs, authentication realms |
+| **Firewall** | Cluster policy, security groups, per-node and per-VM/CT rules |
+| **diff** | Compare two snapshots: added/removed VMs & CTs, config changes, storage drift, user changes |
+
+---
+
+## Prerequisites
+
+### Proxmox API token (recommended)
+
+1. Go to **Datacenter → Permissions → API Tokens** in the web UI
+2. Click **Add** — select the user, set a token ID, uncheck **Privilege Separation** for full
+   read access (or scope it to `VM.Audit`, `Datastore.Audit`, etc. for least privilege)
+3. Copy the token secret — shown only once
+
+### Required API privileges (read-only scan)
+
+| Privilege | Used by |
+|---|---|
+| `VM.Audit` | VMs, containers |
+| `Datastore.Audit` | Storage |
+| `Sys.Audit` | Nodes, network |
+| `Permissions.Read` | Users, ACLs, roles |
+
+---
+
+## Install
+
+```bash
+pip install invctl
+```
+
+With [uv](https://github.com/astral-sh/uv):
+
+```bash
+uv tool install invctl
+```
+
+---
+
+## Configuration
+
+All CLI flags have environment variable equivalents:
+
+| Env var | Flag | Description |
+|---|---|---|
+| `PROXMOX_HOST` | `--host` | Proxmox hostname or IP |
+| `PROXMOX_TOKEN_ID` | `--token-id` | API token ID (`user@realm!tokenname`) |
+| `PROXMOX_TOKEN_SECRET` | `--token-secret` | API token secret |
+| `PROXMOX_USER` | `--user` | Username for password auth |
+| `PROXMOX_PASSWORD` | `--password` | Password for password auth |
+
+Store credentials in a `.env` file and source it:
+
+```bash
+# .env
+PROXMOX_HOST=pve.example.com
+PROXMOX_TOKEN_ID=root@pam!invctl
+PROXMOX_TOKEN_SECRET=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+```
+
+```bash
+source .env && invctl scan
+```
+
+---
+
+## Usage
+
+### Full scan to JSON
+
+```bash
+invctl scan --host pve.example.com \
+  --token-id root@pam!invctl \
+  --token-secret <secret>
+```
+
+### Save a dated snapshot
+
+```bash
+invctl scan --output json --file "inventory-$(date +%Y%m%d).json"
+```
+
+### HTML report
+
+```bash
+invctl scan --output html --file report.html && open report.html
+```
+
+### Markdown report
+
+```bash
+invctl scan --output markdown --file INFRA.md
+```
+
+### Collect specific sections only
+
+```bash
+invctl scan --sections vms,containers
+invctl scan --sections users,firewall --output markdown
+```
+
+### Diff two snapshots
+
+```bash
+invctl diff inventory-20240101.json inventory-20240201.json
+invctl diff old.json new.json --output json | jq '.vms.added'
+invctl diff old.json new.json --output markdown
+```
+
+### Self-signed certificate
+
+```bash
+invctl scan --host 192.168.1.10 --no-verify-ssl
+```
+
+### CLI reference
+
+```
+invctl scan [OPTIONS]
+
+  --host TEXT                       [env: PROXMOX_HOST]
+  --token-id TEXT                   [env: PROXMOX_TOKEN_ID]
+  --token-secret TEXT               [env: PROXMOX_TOKEN_SECRET]
+  --user TEXT                       [env: PROXMOX_USER]
+  --password TEXT                   [env: PROXMOX_PASSWORD]
+  --port INT                        Default: 8006
+  --no-verify-ssl
+  --output [json|html|markdown]     Default: json
+  --file PATH
+  --sections TEXT                   cluster,nodes,vms,containers,
+                                    storage,network,backups,users,firewall
+  --pretty / --no-pretty            Default: --pretty
+
+invctl diff FILE1 FILE2 [OPTIONS]
+
+  --output [text|json|markdown]     Default: text
+```
+
+---
+
+## Contributing
+
+Contributions are welcome — open an issue or pull request on GitHub.
+
+For a guide on how the codebase is structured, how the CI works, and how to add new collectors
+or exporters, see [ARCHITECTURE.md](ARCHITECTURE.md).
+
+Please make sure `ruff check .` and `mypy invctl/` pass before submitting a PR.