meltr 2.0.0a1__tar.gz

meltr-2.0.0a1/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

meltr-2.0.0a1/MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include NOTICE
+include README.md

meltr-2.0.0a1/NOTICE

@@ -0,0 +1,10 @@
+LogForge
+
+Copyright 2024-2026 Fulcrum Technology Solutions and contributors.
+
+This product includes software developed for the LogForge project.
+
+See LICENSE for the Apache License, Version 2.0.
+
+Official Linux release bundles (logforge-*-linux-x86_64.tar.gz) ship THIRD_PARTY_NOTICES.txt
+and PYTHON_PSF_LICENSE.txt for third-party Python packages and the embedded CPython runtime.

meltr-2.0.0a1/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: meltr
+Version: 2.0.0a1
+Summary: Synthetic event log generator with template-based architecture
+Author-email: John Owen <john@ftsc.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Fulcrum-Technology-Solutions/MELTr
+Project-URL: Documentation, https://github.com/Fulcrum-Technology-Solutions/MELTr#readme
+Project-URL: Repository, https://github.com/Fulcrum-Technology-Solutions/MELTr.git
+Project-URL: Issues, https://github.com/Fulcrum-Technology-Solutions/MELTr/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: typer>=0.27.0
+Requires-Dist: requests>=2.34.2
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: fastapi>=0.109.0
+Requires-Dist: uvicorn[standard]>=0.51.0
+Requires-Dist: prometheus-client>=0.19.0
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: faker>=40.28.1
+Requires-Dist: rich>=15.0.0
+Requires-Dist: psutil>=7.2.2
+Provides-Extra: dev
+Requires-Dist: pip-licenses>=5.5.5; extra == "dev"
+Requires-Dist: pytest>=9.1.1; extra == "dev"
+Requires-Dist: pytest-cov>=7.1.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=1.4.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.15.1; extra == "dev"
+Requires-Dist: black>=26.5.1; extra == "dev"
+Requires-Dist: ruff>=0.15.22; extra == "dev"
+Requires-Dist: mypy>=2.3.0; extra == "dev"
+Requires-Dist: httpx>=0.28.1; extra == "dev"
+Requires-Dist: jsonschema>=4.26.0; extra == "dev"
+Dynamic: license-file
+
+# MELTr
+
+MELTr is a synthetic event log generator for SOC, DFIR, and platform teams who need realistic data to test pipelines, detections, and integrations.
+
+> **Formerly LogForge OSS.** The engine lives here now. Community templates still sync from [logforge.io](https://logforge.io) during the transition; other LogForge repos will migrate later.
+
+## Features
+
+- FastAPI management plane + Typer CLI (`meltr`)
+- Jinja2 templates with Faker + entity registry
+- Community template install (`default/` / `custom/`)
+- Pluggable outputs: file, console, HTTP, TCP, syslog
+- Prometheus metrics and resilient output buffering
+- Multi-template pipelines with schedule gates (`continuous`, `window`, `burst`)
+
+## Schedule
+
+Generators and pipelines can gate emission with a `schedule` block. Frequency/variation still controls rate; the schedule decides whether emission is allowed.
+
+| Mode | Behavior |
+|------|----------|
+| `continuous` | Emit whenever started (default) |
+| `window` | Emit only inside tz-aware `days` + `time`; stay running but emit zero outside the window |
+| `burst` | Emit until `count` events **or** `duration`, then auto-stop |
+
+Pipeline example:
+
+```yaml
+pipelines:
+  - name: lab-burst
+    enabled: true
+    outputs: [file-out]
+    schedule:
+      mode: burst
+      count: 1000
+      duration: 5m
+    streams:
+      - template: vendor/product/source/event
+        weight: 1.0
+```
+
+Optional on standalone generators:
+
+```yaml
+generators:
+  - name: business-hours
+    template: vendor/product/source/event
+    enabled: true
+    outputs: [file-out]
+    schedule:
+      mode: window
+      days: [mon, tue, wed, thu, fri]
+      time: "09:00-17:00"
+      timezone: America/New_York
+```
+
+## Install
+
+### From source (development)
+
+```bash
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+meltr init --force
+meltr start --foreground
+```
+
+### PyPI
+
+```bash
+pip install meltr
+meltr init --force
+meltr start --foreground
+```
+
+Requires **Python ≥3.10**. The `logforge` name was taken on PyPI; **`meltr` is the published package name**. Pre-release builds may be tagged `v2.0.0a*` before the stable v2.0.0 release.
+
+## Quick start
+
+```bash
+export MELTR_HOME=~/.meltr   # optional; defaults to ~/.meltr
+meltr init --force
+meltr templates browse
+meltr generators list
+meltr start                  # daemon on POSIX; use --foreground / -f to stay attached
+```
+
+Compat: `LOGFORGE_HOME` and `LOGFORGE_API_KEY` still work if `MELTR_*` is unset. The `logforge` CLI entry point is a temporary alias for `meltr`.
+
+## Templates: preview and updates
+
+Preview renders sample events **without** starting generators (service must be running for CLI; API works standalone):
+
+```bash
+meltr start --foreground          # or daemonized: meltr start
+meltr templates preview testvendor/testproduct/events/preview --count 3
+# API: POST /api/templates/{id}/preview  {"count": 3}
+```
+
+Check installed community packages against the registry ([logforge.io](https://logforge.io) by default):
+
+```bash
+meltr templates check-updates
+# API: GET /api/community/updates
+```
+
+Registry errors exit non-zero from the CLI and return 502 from the API — local installs are never modified.
+
+## Pipelines
+
+Multi-template **pipelines** share outputs and an optional schedule. Each stream maps to one template; the engine spawns child generators (`pipeline-name::0`, `pipeline-name::1`, …). The `streams[].weight` field is accepted in config but **not yet applied** — all streams run at equal rate until weighted selection lands in a future release.
+
+```bash
+meltr pipelines list
+meltr pipelines start identity-lab
+meltr pipelines status identity-lab
+meltr pipelines stop identity-lab
+```
+
+Configure under `pipelines:` in `config.yaml` (see [Schedule](#schedule) below). Standalone `generators:` remain supported for backward compatibility.
+
+## What's not in OSS
+
+MELTr is the **single-node** open-source product. These capabilities live in **LogForge Enterprise** (or a future MELTr Enterprise) only:
+
+- Distributed **worker fleet** and leader–worker job dispatch
+- **LLM-assisted** template authoring in the web UI
+- Postgres-backed manager and multi-tenant UI
+
+See [ecosystem glossary](docs/ecosystem-glossary.md) for shared terminology.
+
+## API authentication
+
+Management routes require a Bearer token when authentication is active. **Key-implies-auth:** setting `MELTR_API_KEY` (or `LOGFORGE_API_KEY`) enables auth even if `api.auth.enabled` is false in config.
+
+| Route | Auth required |
+|-------|---------------|
+| `GET /api/health` | No (public liveness) |
+| All other `/api/*` routes | Yes, when auth is active |
+
+Configure in `config.yaml`:
+
+```yaml
+api:
+  auth:
+    enabled: true   # requires a key at startup
+    key: "your-secret"  # optional if MELTR_API_KEY is set
+```
+
+If `api.auth.enabled: true` and no key is configured (env or config), the API refuses to start. Send requests with `Authorization: Bearer <key>`.
+
+## Environment
+
+| Variable | Purpose |
+|----------|---------|
+| `MELTR_HOME` | Config/data root (default `~/.meltr`) |
+| `MELTR_API_URL` | Management API base URL |
+| `MELTR_API_KEY` | Bearer token when API auth is enabled |
+| `MELTR_TELEMETRY` | Set `0` / `false` to disable telemetry |
+
+## Publishing
+
+PyPI releases use [Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC) — no long-lived API tokens in GitHub secrets.
+
+- Create an empty **`meltr`** project on [pypi.org](https://pypi.org) (or claim it if reserved).
+- In project settings → **Publishing**, add a Trusted Publisher: GitHub, org/repo **`Fulcrum-Technology-Solutions/MELTr`**, workflow **`publish-pypi.yml`**, environment **`pypi`**.
+- In this repo, add a GitHub **environment** named `pypi` (Settings → Environments); optional protection rules for production releases.
+- Push a tag matching `v*` (e.g. `v2.0.0a1`) or run **Publish to PyPI** manually via workflow dispatch after Trusted Publisher is linked.
+
+## Docs
+
+- [Ecosystem glossary](docs/ecosystem-glossary.md)
+- [HTTP destination presets (Cribl / Splunk HEC)](docs/deployment/destination-presets.md)
+- [Development setup](docs/development/setup.md)
+- [Linux tarball deployment](docs/deployment/linux-tarball.md)
+- [v2.0 completion plan](docs/superpowers/plans/2026-08-29-meltr-v2-completion.md)
+- [v2.0.0 release notes](docs/release-notes-2.0.0.md)
+
+## Development
+
+```bash
+pytest   # requires MELTR_HOME (temp dir is fine); coverage gate is 50% on full src/meltr (no whole-file omits)
+```
+
+Phase 6 ships with **interim honest coverage (~50%)**; tracked follow-up is **≥60% without omits** (see [release notes](docs/release-notes-2.0.0.md)).
+
+## License
+
+Apache-2.0

meltr-2.0.0a1/README.md

@@ -0,0 +1,189 @@
+# MELTr
+
+MELTr is a synthetic event log generator for SOC, DFIR, and platform teams who need realistic data to test pipelines, detections, and integrations.
+
+> **Formerly LogForge OSS.** The engine lives here now. Community templates still sync from [logforge.io](https://logforge.io) during the transition; other LogForge repos will migrate later.
+
+## Features
+
+- FastAPI management plane + Typer CLI (`meltr`)
+- Jinja2 templates with Faker + entity registry
+- Community template install (`default/` / `custom/`)
+- Pluggable outputs: file, console, HTTP, TCP, syslog
+- Prometheus metrics and resilient output buffering
+- Multi-template pipelines with schedule gates (`continuous`, `window`, `burst`)
+
+## Schedule
+
+Generators and pipelines can gate emission with a `schedule` block. Frequency/variation still controls rate; the schedule decides whether emission is allowed.
+
+| Mode | Behavior |
+|------|----------|
+| `continuous` | Emit whenever started (default) |
+| `window` | Emit only inside tz-aware `days` + `time`; stay running but emit zero outside the window |
+| `burst` | Emit until `count` events **or** `duration`, then auto-stop |
+
+Pipeline example:
+
+```yaml
+pipelines:
+  - name: lab-burst
+    enabled: true
+    outputs: [file-out]
+    schedule:
+      mode: burst
+      count: 1000
+      duration: 5m
+    streams:
+      - template: vendor/product/source/event
+        weight: 1.0
+```
+
+Optional on standalone generators:
+
+```yaml
+generators:
+  - name: business-hours
+    template: vendor/product/source/event
+    enabled: true
+    outputs: [file-out]
+    schedule:
+      mode: window
+      days: [mon, tue, wed, thu, fri]
+      time: "09:00-17:00"
+      timezone: America/New_York
+```
+
+## Install
+
+### From source (development)
+
+```bash
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+meltr init --force
+meltr start --foreground
+```
+
+### PyPI
+
+```bash
+pip install meltr
+meltr init --force
+meltr start --foreground
+```
+
+Requires **Python ≥3.10**. The `logforge` name was taken on PyPI; **`meltr` is the published package name**. Pre-release builds may be tagged `v2.0.0a*` before the stable v2.0.0 release.
+
+## Quick start
+
+```bash
+export MELTR_HOME=~/.meltr   # optional; defaults to ~/.meltr
+meltr init --force
+meltr templates browse
+meltr generators list
+meltr start                  # daemon on POSIX; use --foreground / -f to stay attached
+```
+
+Compat: `LOGFORGE_HOME` and `LOGFORGE_API_KEY` still work if `MELTR_*` is unset. The `logforge` CLI entry point is a temporary alias for `meltr`.
+
+## Templates: preview and updates
+
+Preview renders sample events **without** starting generators (service must be running for CLI; API works standalone):
+
+```bash
+meltr start --foreground          # or daemonized: meltr start
+meltr templates preview testvendor/testproduct/events/preview --count 3
+# API: POST /api/templates/{id}/preview  {"count": 3}
+```
+
+Check installed community packages against the registry ([logforge.io](https://logforge.io) by default):
+
+```bash
+meltr templates check-updates
+# API: GET /api/community/updates
+```
+
+Registry errors exit non-zero from the CLI and return 502 from the API — local installs are never modified.
+
+## Pipelines
+
+Multi-template **pipelines** share outputs and an optional schedule. Each stream maps to one template; the engine spawns child generators (`pipeline-name::0`, `pipeline-name::1`, …). The `streams[].weight` field is accepted in config but **not yet applied** — all streams run at equal rate until weighted selection lands in a future release.
+
+```bash
+meltr pipelines list
+meltr pipelines start identity-lab
+meltr pipelines status identity-lab
+meltr pipelines stop identity-lab
+```
+
+Configure under `pipelines:` in `config.yaml` (see [Schedule](#schedule) below). Standalone `generators:` remain supported for backward compatibility.
+
+## What's not in OSS
+
+MELTr is the **single-node** open-source product. These capabilities live in **LogForge Enterprise** (or a future MELTr Enterprise) only:
+
+- Distributed **worker fleet** and leader–worker job dispatch
+- **LLM-assisted** template authoring in the web UI
+- Postgres-backed manager and multi-tenant UI
+
+See [ecosystem glossary](docs/ecosystem-glossary.md) for shared terminology.
+
+## API authentication
+
+Management routes require a Bearer token when authentication is active. **Key-implies-auth:** setting `MELTR_API_KEY` (or `LOGFORGE_API_KEY`) enables auth even if `api.auth.enabled` is false in config.
+
+| Route | Auth required |
+|-------|---------------|
+| `GET /api/health` | No (public liveness) |
+| All other `/api/*` routes | Yes, when auth is active |
+
+Configure in `config.yaml`:
+
+```yaml
+api:
+  auth:
+    enabled: true   # requires a key at startup
+    key: "your-secret"  # optional if MELTR_API_KEY is set
+```
+
+If `api.auth.enabled: true` and no key is configured (env or config), the API refuses to start. Send requests with `Authorization: Bearer <key>`.
+
+## Environment
+
+| Variable | Purpose |
+|----------|---------|
+| `MELTR_HOME` | Config/data root (default `~/.meltr`) |
+| `MELTR_API_URL` | Management API base URL |
+| `MELTR_API_KEY` | Bearer token when API auth is enabled |
+| `MELTR_TELEMETRY` | Set `0` / `false` to disable telemetry |
+
+## Publishing
+
+PyPI releases use [Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC) — no long-lived API tokens in GitHub secrets.
+
+- Create an empty **`meltr`** project on [pypi.org](https://pypi.org) (or claim it if reserved).
+- In project settings → **Publishing**, add a Trusted Publisher: GitHub, org/repo **`Fulcrum-Technology-Solutions/MELTr`**, workflow **`publish-pypi.yml`**, environment **`pypi`**.
+- In this repo, add a GitHub **environment** named `pypi` (Settings → Environments); optional protection rules for production releases.
+- Push a tag matching `v*` (e.g. `v2.0.0a1`) or run **Publish to PyPI** manually via workflow dispatch after Trusted Publisher is linked.
+
+## Docs
+
+- [Ecosystem glossary](docs/ecosystem-glossary.md)
+- [HTTP destination presets (Cribl / Splunk HEC)](docs/deployment/destination-presets.md)
+- [Development setup](docs/development/setup.md)
+- [Linux tarball deployment](docs/deployment/linux-tarball.md)
+- [v2.0 completion plan](docs/superpowers/plans/2026-08-29-meltr-v2-completion.md)
+- [v2.0.0 release notes](docs/release-notes-2.0.0.md)
+
+## Development
+
+```bash
+pytest   # requires MELTR_HOME (temp dir is fine); coverage gate is 50% on full src/meltr (no whole-file omits)
+```
+
+Phase 6 ships with **interim honest coverage (~50%)**; tracked follow-up is **≥60% without omits** (see [release notes](docs/release-notes-2.0.0.md)).
+
+## License
+
+Apache-2.0