{"name":"@deckyard/unraid","description":"A client for the Unraid GraphQL API: system, array, disks, Docker containers, VMs, notifications and API keys","versions":{"0.1.0":{"version":"0.1.0","kind":"git","url":"https://github.com/deckyard/deck-unraid.git","ref":"0.1.0","commit":"c41497ff924fa1c0f45478acec85cb982991ef20","checksum":"","yanked":false,"license":"LGPL-3.0-only","requires":{},"engines":{"jennifer":"\u003e=0.26.0"},"capabilities":["net"],"keywords":["unraid","nas","homelab","docker","virtualization"],"description":"A client for the Unraid GraphQL API: system, array, disks, Docker containers, VMs, notifications and API keys","publishedAt":"1793820273","repoId":1446066364,"repoOwnerId":346943577,"repoOwner":"deckyard"}},"readme":"# @deckyard/unraid\n\n[![test](https://github.com/deckyard/deck-unraid/actions/workflows/test.yml/badge.svg)](https://github.com/deckyard/deck-unraid/actions/workflows/test.yml)\n[![Documentation](https://img.shields.io/badge/docs-github%20pages-blue)](https://deckyard.github.io/deck-unraid/)\n[![release](https://img.shields.io/github/v/release/deckyard/deck-unraid)](https://github.com/deckyard/deck-unraid/releases/latest)\n\nA [Jennifer](https://jennifer-lang.dev/) client for the\n[Unraid API](https://docs.unraid.net/API/), the GraphQL API of Unraid 7.2 and\nnewer: system and metrics, the array, disks, shares and parity checks, Docker\ncontainers, virtual machines, notifications, logs and API keys.\n\n**[Documentation](https://deckyard.github.io/deck-unraid/)**\n\n## Install\n\n```sh\njvc add @deckyard/unraid\n```\n\nThis vendors the deck to `vendor/\u003cscope\u003e/unraid/`. Without `jvc`, unpack the\n`src/` subtree of a release archive (`\u003cscope\u003e-unraid-\u003cversion\u003e.tar.gz`) there.\n\n## Usage\n\n```jennifer\nimport \"@deckyard/unraid/\" as unraid;\n\ndef c as unraid.Client init unraid.withApiKey(unraid.client(\"tower.local\"), $key);\nfor (def ct in unraid.containers($c)) {\n    io.printf(\"%s %s\\n\", $ct.name, $ct.state);\n}\nunraid.startVm($c, unraid.vmByName($c, \"win11\").id);\n```\n\n## Requirements\n\nJennifer 0.26.0 or newer, default `jennifer` binary (`net`; not\n`jennifer-tiny`). An Unraid server running 7.2 or newer, or the Unraid\nConnect plugin, and an API key.\n\n## Development\n\n```sh\ntools/check-all.sh                   # the full gate, as CI runs it\njennifer test src/unraid_test.j      # the test overlay\ntools/check-docs.sh                  # docs against the code\ntools/pack.sh dist                   # build the release archive\n```\n\n## Licence\n\nLGPL-3.0-only, see [LICENSE](LICENSE). Copyright (C) 2026 mplx \u0026lt;mplx@jennifer-lang.dev\u0026gt;.\n\n`tools/check-headers.sh` checks every source file's SPDX header against\n`deck.toml`.\n"}