wyrmctl 0.4.5__tar.gz

wyrmctl-0.4.5/LICENSE

@@ -0,0 +1,183 @@
+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 2026 npmctl contributors
+
+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.

wyrmctl-0.4.5/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: wyrmctl
+Version: 0.4.5
+Summary: Owner-scoped plan/apply/adopt controller for Nginx Proxy Manager resources.
+Keywords: nginx-proxy-manager,npm,reverse-proxy,gitops,desired-state,infrastructure-as-code,controller,plan-apply,owner-scoped,dns,dns-management,dns-provider,dns-records,ssl-certificates,access-lists,a-record,aaaa-record,cname-record,txt-record,mx-record,srv-record,caa-record
+Author: Jacob Stewart
+Author-email: Jacob Stewart <jacob@swarmauri.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: Name Service (DNS)
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: requests>=2.32.0
+Requires-Dist: tomli>=2.0.1 ; python_full_version < '3.11'
+Requires-Dist: cryptography>=44.0.0 ; extra == 'signing'
+Requires-Python: >=3.10, <3.15
+Project-URL: Homepage, https://github.com/groupsum/wyrmctl
+Project-URL: Documentation, https://github.com/groupsum/wyrmctl/tree/master/docs
+Project-URL: Issues, https://github.com/groupsum/wyrmctl/issues
+Project-URL: Repository, https://github.com/groupsum/wyrmctl
+Provides-Extra: signing
+Description-Content-Type: text/markdown
+
+<h1 align="center">wyrmctl</h1>
+
+<p align="center"><strong>Owner-scoped GitOps for Nginx Proxy Manager</strong></p>
+
+<p align="center">
+  Validate desired-state YAML, plan safe owner-scoped changes, apply clean reconciles, and adopt existing NPM resources only when you ask for it.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/wyrmctl/"><img src="https://img.shields.io/pypi/v/wyrmctl.svg" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/wyrmctl/"><img src="https://img.shields.io/pypi/pyversions/wyrmctl.svg" alt="Python versions"></a>
+  <a href="https://github.com/groupsum/wyrmctl/actions/workflows/ci.yml"><img src="https://github.com/groupsum/wyrmctl/actions/workflows/ci.yml/badge.svg?branch=master" alt="CI"></a>
+  <a href="https://github.com/groupsum/wyrmctl/actions/workflows/live-npm-gate.yml"><img src="https://github.com/groupsum/wyrmctl/actions/workflows/live-npm-gate.yml/badge.svg?branch=master" alt="Live NPM Gate"></a>
+  <a href="https://github.com/groupsum/wyrmctl/blob/master/.ssot/registry.json"><img src="https://img.shields.io/badge/SSOT-governed-2f6f4e.svg" alt="SSOT governed"></a>
+  <a href="https://github.com/groupsum/wyrmctl/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Apache 2.0 License"></a>
+</p>
+
+<p align="center">
+  <a href="https://hits.sh/github.com/groupsum/wyrmctl/blob/master/packages/wyrmctl/README.md/"><img src="https://hits.sh/github.com/groupsum/wyrmctl/blob/master/packages/wyrmctl/README.md.svg?label=wyrmctl%20package%20hits" alt="wyrmctl package hits"></a>
+  <a href="https://pepy.tech/projects/wyrmctl"><img src="https://static.pepy.tech/badge/wyrmctl" alt="wyrmctl downloads"></a>
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/groupsum/wyrmctl/master/docs/images/marketing/wyrmctl-architecture-infographic.png" alt="wyrmctl architecture infographic">
+</p>
+
+`wyrmctl` is the Python package and console script for declarative, owner-scoped Nginx Proxy Manager automation. It manages proxy hosts, certificates, access lists, redirection hosts, dead hosts, streams, users, settings, and provider-backed DNS records without silently mutating foreign-owned resources.
+
+## Supported Python Versions
+
+`wyrmctl` supports Python `3.10`, `3.11`, `3.12`, `3.13`, and `3.14`.
+
+## Why wyrmctl
+
+- Owner-scoped reconciliation instead of global mutable state
+- Explicit `plan`, `apply`, and `adopt` flows instead of ad hoc API scripting
+- Safe reference handling for certificates and access lists
+- Fail-closed behavior when the target NPM schema does not support a required operation
+- CLI-first workflows that fit GitOps, CI, and controlled repair operations
+- Independently versioned contracts, reproducibility lockfiles, and immutable reviewed plan artifacts
+- Transactional adjacent migrations with backups, chained ledgers, leases, and explicit recovery classification
+
+## FAQ
+
+### What is wyrmctl?
+
+**Answer:** `wyrmctl` is a GitOps-style controller for Nginx Proxy Manager that reads desired-state YAML, compares it to the live NPM API, and produces safe owner-scoped plans before any mutation happens.
+
+### What problem does wyrmctl solve?
+
+**Answer:** `wyrmctl` replaces manual NPM clicking and one-off API scripts with repeatable desired state, explicit adoption, conflict detection, and controlled reconciliation for reverse-proxy resources.
+
+### Does wyrmctl modify resources it does not own?
+
+**Answer:** No. `wyrmctl` treats NPM resources as owner-scoped, refuses to mutate foreign-owned resources, and only attaches metadata to unmanaged resources when you run `wyrmctl adopt`.
+
+### How does wyrmctl handle certificate issuance and rotation?
+
+**Answer:** `wyrmctl` treats certificates as declarative resources in the same desired state as proxy hosts. Issuance happens when a desired certificate must be created, and rotation happens through explicit reconcile policy rather than hidden mutation of unrelated resources.
+
+### Can wyrmctl adopt existing manually created NPM resources?
+
+**Answer:** Yes. `wyrmctl adopt` can attach wyrmctl ownership metadata to compatible unmanaged resources so future plans and applies can manage them under explicit owner scope.
+
+## Install
+
+Use `pipx` for an isolated CLI install:
+
+```bash
+pipx install wyrmctl
+wyrmctl --version
+```
+
+Use `uv` if you manage tools with uv:
+
+```bash
+uv tool install wyrmctl
+wyrmctl --help
+```
+
+Use `pip` inside an existing virtual environment:
+
+```bash
+python -m venv .venv
+. .venv/bin/activate
+python -m pip install wyrmctl
+wyrmctl --help
+```
+
+PowerShell activation:
+
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install wyrmctl
+wyrmctl --help
+```
+
+## Configure NPM
+
+Set Nginx Proxy Manager API credentials as environment variables:
+
+```bash
+export NPM_BASE_URL=http://127.0.0.1:81/api
+export NPM_IDENTITY=admin@example.com
+export NPM_SECRET=changeme
+```
+
+Or pass them directly:
+
+```bash
+wyrmctl --base-url http://127.0.0.1:81/api --identity admin@example.com --secret changeme health
+```
+
+## Quick Start
+
+Validate desired state without touching the API:
+
+```bash
+wyrmctl validate ./desired-state
+wyrmctl --output json validate ./desired-state
+```
+
+Plan owner-scoped changes:
+
+```bash
+wyrmctl plan ./desired-state --owner workload-a
+```
+
+Apply a clean plan:
+
+```bash
+wyrmctl apply ./desired-state --owner workload-a
+```
+
+Adopt unmanaged matching resources:
+
+```bash
+wyrmctl adopt ./desired-state --owner workload-a
+wyrmctl adopt ./desired-state --owner workload-a --allow-field-drift
+```
+
+## Desired State
+
+Every managed resource needs wyrmctl ownership metadata:
+
+```yaml
+apiVersion: wyrmctl.com/v1
+schemaVersion: 2
+proxy_hosts:
+  - domain_names: [app.example.com]
+    forward_scheme: http
+    forward_host: app
+    forward_port: 3000
+    meta:
+      managed_by: wyrmctl
+      owner: workload-a
+      resource_id: proxy.app
+```
+
+References use `resource_id` values:
+
+```yaml
+apiVersion: wyrmctl.com/v1
+schemaVersion: 2
+certificates:
+  - name: wildcard-example
+    domain_names: ["*.example.com", example.com]
+    certificate_type: letsencrypt
+    api_payload:
+      provider: letsencrypt
+    meta:
+      managed_by: wyrmctl
+      owner: workload-a
+      resource_id: cert.wildcard-example
+access_lists:
+  - name: private-admins
+    api_payload:
+      satisfy_any: 0
+      items: []
+      clients: []
+    meta:
+      managed_by: wyrmctl
+      owner: workload-a
+      resource_id: acl.private-admins
+proxy_hosts:
+  - domain_names: [app.example.com]
+    forward_host: app
+    forward_port: 3000
+    certificate_ref: cert.wildcard-example
+    access_list_ref: acl.private-admins
+    ssl_forced: 1
+    allow_websocket_upgrade: 1
+    caching_enabled: 1
+    block_exploits: 1
+    meta:
+      managed_by: wyrmctl
+      owner: workload-a
+      resource_id: proxy.app
+```
+
+## More Documentation
+
+- Related PyPI package: https://pypi.org/project/wyrmctl-namecheap/
+- Repository: https://github.com/groupsum/wyrmctl
+- Examples: https://github.com/groupsum/wyrmctl/tree/master/examples/desired-state
+- Docs: https://github.com/groupsum/wyrmctl/tree/master/docs

wyrmctl-0.4.5/README.md

@@ -0,0 +1,207 @@
+<h1 align="center">wyrmctl</h1>
+
+<p align="center"><strong>Owner-scoped GitOps for Nginx Proxy Manager</strong></p>
+
+<p align="center">
+  Validate desired-state YAML, plan safe owner-scoped changes, apply clean reconciles, and adopt existing NPM resources only when you ask for it.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/wyrmctl/"><img src="https://img.shields.io/pypi/v/wyrmctl.svg" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/wyrmctl/"><img src="https://img.shields.io/pypi/pyversions/wyrmctl.svg" alt="Python versions"></a>
+  <a href="https://github.com/groupsum/wyrmctl/actions/workflows/ci.yml"><img src="https://github.com/groupsum/wyrmctl/actions/workflows/ci.yml/badge.svg?branch=master" alt="CI"></a>
+  <a href="https://github.com/groupsum/wyrmctl/actions/workflows/live-npm-gate.yml"><img src="https://github.com/groupsum/wyrmctl/actions/workflows/live-npm-gate.yml/badge.svg?branch=master" alt="Live NPM Gate"></a>
+  <a href="https://github.com/groupsum/wyrmctl/blob/master/.ssot/registry.json"><img src="https://img.shields.io/badge/SSOT-governed-2f6f4e.svg" alt="SSOT governed"></a>
+  <a href="https://github.com/groupsum/wyrmctl/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Apache 2.0 License"></a>
+</p>
+
+<p align="center">
+  <a href="https://hits.sh/github.com/groupsum/wyrmctl/blob/master/packages/wyrmctl/README.md/"><img src="https://hits.sh/github.com/groupsum/wyrmctl/blob/master/packages/wyrmctl/README.md.svg?label=wyrmctl%20package%20hits" alt="wyrmctl package hits"></a>
+  <a href="https://pepy.tech/projects/wyrmctl"><img src="https://static.pepy.tech/badge/wyrmctl" alt="wyrmctl downloads"></a>
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/groupsum/wyrmctl/master/docs/images/marketing/wyrmctl-architecture-infographic.png" alt="wyrmctl architecture infographic">
+</p>
+
+`wyrmctl` is the Python package and console script for declarative, owner-scoped Nginx Proxy Manager automation. It manages proxy hosts, certificates, access lists, redirection hosts, dead hosts, streams, users, settings, and provider-backed DNS records without silently mutating foreign-owned resources.
+
+## Supported Python Versions
+
+`wyrmctl` supports Python `3.10`, `3.11`, `3.12`, `3.13`, and `3.14`.
+
+## Why wyrmctl
+
+- Owner-scoped reconciliation instead of global mutable state
+- Explicit `plan`, `apply`, and `adopt` flows instead of ad hoc API scripting
+- Safe reference handling for certificates and access lists
+- Fail-closed behavior when the target NPM schema does not support a required operation
+- CLI-first workflows that fit GitOps, CI, and controlled repair operations
+- Independently versioned contracts, reproducibility lockfiles, and immutable reviewed plan artifacts
+- Transactional adjacent migrations with backups, chained ledgers, leases, and explicit recovery classification
+
+## FAQ
+
+### What is wyrmctl?
+
+**Answer:** `wyrmctl` is a GitOps-style controller for Nginx Proxy Manager that reads desired-state YAML, compares it to the live NPM API, and produces safe owner-scoped plans before any mutation happens.
+
+### What problem does wyrmctl solve?
+
+**Answer:** `wyrmctl` replaces manual NPM clicking and one-off API scripts with repeatable desired state, explicit adoption, conflict detection, and controlled reconciliation for reverse-proxy resources.
+
+### Does wyrmctl modify resources it does not own?
+
+**Answer:** No. `wyrmctl` treats NPM resources as owner-scoped, refuses to mutate foreign-owned resources, and only attaches metadata to unmanaged resources when you run `wyrmctl adopt`.
+
+### How does wyrmctl handle certificate issuance and rotation?
+
+**Answer:** `wyrmctl` treats certificates as declarative resources in the same desired state as proxy hosts. Issuance happens when a desired certificate must be created, and rotation happens through explicit reconcile policy rather than hidden mutation of unrelated resources.
+
+### Can wyrmctl adopt existing manually created NPM resources?
+
+**Answer:** Yes. `wyrmctl adopt` can attach wyrmctl ownership metadata to compatible unmanaged resources so future plans and applies can manage them under explicit owner scope.
+
+## Install
+
+Use `pipx` for an isolated CLI install:
+
+```bash
+pipx install wyrmctl
+wyrmctl --version
+```
+
+Use `uv` if you manage tools with uv:
+
+```bash
+uv tool install wyrmctl
+wyrmctl --help
+```
+
+Use `pip` inside an existing virtual environment:
+
+```bash
+python -m venv .venv
+. .venv/bin/activate
+python -m pip install wyrmctl
+wyrmctl --help
+```
+
+PowerShell activation:
+
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install wyrmctl
+wyrmctl --help
+```
+
+## Configure NPM
+
+Set Nginx Proxy Manager API credentials as environment variables:
+
+```bash
+export NPM_BASE_URL=http://127.0.0.1:81/api
+export NPM_IDENTITY=admin@example.com
+export NPM_SECRET=changeme
+```
+
+Or pass them directly:
+
+```bash
+wyrmctl --base-url http://127.0.0.1:81/api --identity admin@example.com --secret changeme health
+```
+
+## Quick Start
+
+Validate desired state without touching the API:
+
+```bash
+wyrmctl validate ./desired-state
+wyrmctl --output json validate ./desired-state
+```
+
+Plan owner-scoped changes:
+
+```bash
+wyrmctl plan ./desired-state --owner workload-a
+```
+
+Apply a clean plan:
+
+```bash
+wyrmctl apply ./desired-state --owner workload-a
+```
+
+Adopt unmanaged matching resources:
+
+```bash
+wyrmctl adopt ./desired-state --owner workload-a
+wyrmctl adopt ./desired-state --owner workload-a --allow-field-drift
+```
+
+## Desired State
+
+Every managed resource needs wyrmctl ownership metadata:
+
+```yaml
+apiVersion: wyrmctl.com/v1
+schemaVersion: 2
+proxy_hosts:
+  - domain_names: [app.example.com]
+    forward_scheme: http
+    forward_host: app
+    forward_port: 3000
+    meta:
+      managed_by: wyrmctl
+      owner: workload-a
+      resource_id: proxy.app
+```
+
+References use `resource_id` values:
+
+```yaml
+apiVersion: wyrmctl.com/v1
+schemaVersion: 2
+certificates:
+  - name: wildcard-example
+    domain_names: ["*.example.com", example.com]
+    certificate_type: letsencrypt
+    api_payload:
+      provider: letsencrypt
+    meta:
+      managed_by: wyrmctl
+      owner: workload-a
+      resource_id: cert.wildcard-example
+access_lists:
+  - name: private-admins
+    api_payload:
+      satisfy_any: 0
+      items: []
+      clients: []
+    meta:
+      managed_by: wyrmctl
+      owner: workload-a
+      resource_id: acl.private-admins
+proxy_hosts:
+  - domain_names: [app.example.com]
+    forward_host: app
+    forward_port: 3000
+    certificate_ref: cert.wildcard-example
+    access_list_ref: acl.private-admins
+    ssl_forced: 1
+    allow_websocket_upgrade: 1
+    caching_enabled: 1
+    block_exploits: 1
+    meta:
+      managed_by: wyrmctl
+      owner: workload-a
+      resource_id: proxy.app
+```
+
+## More Documentation
+
+- Related PyPI package: https://pypi.org/project/wyrmctl-namecheap/
+- Repository: https://github.com/groupsum/wyrmctl
+- Examples: https://github.com/groupsum/wyrmctl/tree/master/examples/desired-state
+- Docs: https://github.com/groupsum/wyrmctl/tree/master/docs