@corrreia/hl 0.0.0-stage → 0.1.0

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 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 consequential 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tomás Correia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,135 @@
-# Temporary Holding Version
+# hl
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+One CLI for the self-hosted services in your homelab. Each service's commands are generated from its OpenAPI spec
+with [Forge](https://github.com/cloudflare/forge), the way Cloudflare builds [`cf`](https://github.com/cloudflare/cf).
+
+21 services, each with every API version its project has published (`hl services` lists them):
+
+| Area    | Services                                                                                                                |
+| ------- | ----------------------------------------------------------------------------------------------------------------------- |
+| Network | UniFi Network `unifi`, AdGuard Home `adguard`                                                                           |
+| Media   | Jellyfin `jellyfin`, Immich `immich`, Audiobookshelf `audiobookshelf`, Kavita `kavita`, Komga `komga`                   |
+| *arr    | Sonarr `sonarr`, Radarr `radarr`, Lidarr `lidarr`, Prowlarr `prowlarr`, Seerr/Jellyseerr `seerr`, Overseerr `overseerr` |
+| Other   | Frigate `frigate`, Grafana `grafana`, authentik `authentik`, Karakeep `karakeep`, Speedtest Tracker `speedtest-tracker` |
+
+What `--api-key` takes depends on the service: an API key for most, `user:password` for AdGuard Home, a service account
+token for Grafana, an API token for authentik. Frigate's unauthenticated port needs none. Karakeep and Speedtest Tracker
+can't say their version, so pin one with `--pin-version` (otherwise the newest is used).
+
+```sh
+npm i -g @corrreia/hl
+hl --help
+```
+
+Or from a clone:
+
+```sh
+pnpm install
+pnpm build          # forge plugin → catalogues → dist/
+./bin/hl --help     # or, without building: pnpm dev --help
+```
+
+## Instances
+
+A service can have several servers. Add each with a name; the first is the default.
+
+```sh
+hl instances add unifi home  --url https://192.168.1.1 --insecure          # asks for the key
+hl instances add unifi cabin --url https://10.0.0.1 --api-key-cmd "pass show homelab/unifi-cabin"
+hl instances list
+hl instances use unifi cabin       # change the default
+hl instances refresh               # ask every server for its version again
+```
+
+`--insecure` accepts a self-signed certificate, as most consoles have.
+
+### Keys
+
+| How                                                                   | What hl keeps                                                                                                                                                              |
+| --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Nothing (hl asks, without echoing), `--api-key-stdin`, or `--api-key` | The key, in the system keyring: the Secret Service (GNOME Keyring, KWallet, KeePassXC) through `secret-tool`, or the macOS Keychain. The config file has only a reference. |
+| `--api-key-cmd "<command>"`                                           | The command, run each time a key is needed: `pass show …`, `op read …`, `bw get password …`                                                                                |
+| `--api-key-env NAME`                                                  | The variable's name, read each time                                                                                                                                        |
+| `--store-in-config`                                                   | The key, in the config file (mode 0600), for machines without a keyring                                                                                                    |
+
+Without a keyring, hl won't fall back to the config file on its own; it says so and suggests the others. `--api-key`
+works but stays in your shell history.
+The config is `~/.config/hl/config.json` (`$HL_CONFIG` overrides it).
+
+## Commands
+
+```sh
+hl unifi devices list                         # the default instance, its default (or only) site
+hl unifi@cabin devices list --site guest      # another instance, a site by name or reference
+hl unifi devices list --all -o table          # every instance, one table with an INSTANCE column
+hl unifi clients list --all-pages             # every page
+hl unifi vouchers create --name Guests --time-limit-minutes 60 --count 5
+hl unifi firewall policies create --body @policy.json
+hl unifi devices remove <device-id>           # asks first; --yes to skip
+hl unifi wifi list --dry-run                  # print the request instead
+```
+
+Output is JSON (indented on a terminal, compact when piped); `-o table` prints a list's scalar columns, and
+`--columns name,state` picks them.
+
+## Versions
+
+`hl` asks each server which version it runs, when it is added and again once a day, and builds that instance's
+commands from the newest bundled spec that isn't newer. `hl unifi@cabin --help` shows the commands cabin's version
+has. With `--all`, every instance runs the command as its own version has it, and one without it is skipped.
+
+## How it's built
+
+```
+specs/<service>/<version>.json
+  └─ overlay (src/services/<service>/overlay.ts): names every operation
+       └─ forge --target wasm://generator/hl.wasm   (plugin: generator/plugin.ts)
+            └─ src/services/<service>/_generated/<version>.ts   (a command catalogue)
+```
+
+The runtime builds yargs commands from the catalogue of the instance a run is for. A service's hand-written definition
+(`src/services/<service>/service.ts`) says what the spec doesn't: where the API lives, how to authenticate, how to ask
+for the version, context parameters such as UniFi's `--site`, and paging.
+
+Each service's `spec.ts` says where its specs are published (release tags in its git repository, or a page that lists
+versions) and how to name its operations: by hand (UniFi), or derived from each operation's tag and operationId, or its
+method and path, with overrides. A service's catalogues share most commands, so they're kept as one module per service
+with each distinct command once.
+
+### Services without a usable spec
+
+Some projects don't publish an OpenAPI document, so `hl` makes one; the code is in this repository and runs as part of
+`pnpm fetch-specs`:
+
+| Service        | What's published                                                                   | How it becomes OpenAPI 3                                                                                                                                                                   |
+| -------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Proxmox VE     | The API viewer's schema (`apidoc.js`), in each release's `pve-docs` Debian package | `generator/debian.ts` downloads it from Proxmox's repository, verified against its signed `InRelease` (keys over HTTPS) and the package hashes; `generator/convert/proxmox.ts` converts it |
+| Home Assistant | REST API documentation only                                                        | `src/services/home-assistant/openapi.ts`, written by hand from the docs                                                                                                                    |
+| Portainer CE   | Split multi-file specs (newer) and Swagger 2 (older)                               | `generator/load-spec.ts` bundles the files' `$ref`s and converts Swagger 2; any other service's Swagger 2 or split spec loads the same way                                                 |
+
+Fetching Proxmox needs `gpgv`, `ar` and `tar`.
+
+### New versions
+
+`pnpm fetch-specs` downloads each service's newest published versions not in `specs/` yet, and keeps only those whose
+API differs from the version before (the rest are listed in `specs/<id>/skipped.txt`). A server between two kept
+versions uses the older one's commands, which are its API. Then `pnpm generate`.
+
+### Adding a service
+
+1. `src/services/<id>/spec.ts`: where its specs are, and how to name operations (see `generator/spec-config.ts`)
+2. `src/services/<id>/service.ts`: `defineService` with its base path, auth, and version route
+3. `pnpm fetch-specs <id> && pnpm generate <id>`, then add it to `src/services/registry.ts` and to the version probes in
+   `src/services/services.test.ts`.
+
+## Development
+
+```sh
+pnpm generate   # build the plugin and the catalogues (not committed); run it first
+pnpm test       # tests run hl against fake servers on localhost
+pnpm check      # types, lint, format
+```
+
+CI checks every push. A weekly workflow runs `pnpm fetch-specs` and opens a pull request with any new versions. To
+release, bump `version` in `package.json` and push a matching tag (`v0.2.0`); the release workflow publishes to npm
+with provenance.

package/bin/hl

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+const major = Number(process.versions.node.split(".")[0]);
+if (!(major >= 22)) {
+	console.error(`hl needs Node.js 22 or newer; this is ${process.versions.node}.`);
+	process.exit(1);
+}
+await import("../dist/index.mjs");