|
1 | 1 | # ProxmoxSharp |
2 | 2 |
|
| 3 | +[](https://www.nuget.org/packages/Chrison.ProxmoxSharp/) |
| 4 | +[](https://www.nuget.org/packages/Chrison.ProxmoxSharp/) |
| 5 | +[](https://github.com/Chrison-dev/ProxmoxSharp/actions/workflows/ci.yml) |
| 6 | +[](https://github.com/Fallout-build/Fallout) |
| 7 | +[](LICENSE) |
| 8 | + |
3 | 9 | A C# API client for Proxmox VE — **mostly code-generated from Proxmox's own |
4 | 10 | published API schema**, with a thin hand-written runtime for auth and transport. |
5 | 11 |
|
6 | | -Built to be dogfooded by the [Homelab](https://github.com/Chrison-dev/Homelab) |
| 12 | +```sh |
| 13 | +dotnet add package Chrison.ProxmoxSharp |
| 14 | +dotnet tool install -g Chrison.ProxmoxSharp.Cli # the `proxmoxsharp` CLI |
| 15 | +``` |
| 16 | + |
| 17 | +Built to be dogfooded by the [Homelab](https://github.com/Chrison-Homelab/Homelab) |
7 | 18 | hub's C#-native IaC (the Discover → Converge path). Design + roadmap live in the |
8 | 19 | hub at `docs/plans/BL-009-proxmoxsharp-codegen.md`. |
9 | 20 |
|
10 | 21 | ## Approach |
11 | 22 |
|
| 23 | +```mermaid |
| 24 | +flowchart LR |
| 25 | + APIDOC["📜 apidoc.js<br/>(pinned, from our node)"] --> SG["🔧 ProxmoxSharp.SchemaGen<br/>apidoc → OpenAPI 3.0"] |
| 26 | + SG --> KIOTA["⚙️ Kiota (pinned tool)<br/>generate C# client"] |
| 27 | + KIOTA --> API["📦 ProxmoxSharp.Api<br/>generated · tracks PVE version"] |
| 28 | + API --> RT["✍️ ProxmoxSharp<br/>hand-written runtime<br/>(token auth · {data:…} envelope)"] |
| 29 | + RT --> CLI["🖥️ proxmoxsharp CLI"] |
| 30 | + classDef gen fill:#e0e7ff,stroke:#4f46e5; |
| 31 | + class API gen; |
12 | 32 | ``` |
13 | | -apidoc.js (version-matched, pulled from our node) |
14 | | - │ ProxmoxSharp.SchemaGen → OpenAPI 3.0 |
15 | | - ▼ |
16 | | -Kiota (pinned dotnet tool) → generated C# request builders + models (ProxmoxSharp.Api) |
17 | | - ▼ |
18 | | -ProxmoxSharp = hand-written runtime over it (PVEAPIToken auth, {data:…} envelope) |
19 | | -``` |
| 33 | + |
| 34 | +The generated client is **regenerated on build** (incrementally — only when the |
| 35 | +schema changes) and **not committed**. |
20 | 36 |
|
21 | 37 | The generated client is **regenerated on build** (incrementally — only when the |
22 | 38 | schema changes) and **not committed**. Day-to-day work on the hand-written |
|
0 commit comments