@vulcan-energy/community-cli 0.0.0-stage → 0.1.0

package/LICENSES/OGL-UK-3.0.txt

@@ -0,0 +1,89 @@
+Open Government Licence for public sector information
+
+You are encouraged to use and re-use the Information that is available under this licence freely and flexibly, with only a few conditions.
+
+Using Information under this licence
+
+Use of copyright and database right material expressly made available under this licence (the 'Information') indicates your acceptance of the terms and conditions below.
+
+The Licensor grants you a worldwide, royalty-free, perpetual, non-exclusive licence to use the Information subject to the conditions below.
+
+This licence does not affect your freedom under fair dealing or fair use or any other copyright or database right exceptions and limitations.
+
+You are free to:
+
+- copy, publish, distribute and transmit the Information;
+
+- adapt the Information;
+
+-  exploit the Information commercially and non-commercially for example, by combining it with other Information, or by including it in your own product or application.
+
+You must (where you do any of the above):
+
+- acknowledge the source of the Information in your product or application by including or linking to any attribution statement specified by the Information Provider(s) and, where possible, provide a link to this licence;
+
+If the Information Provider does not provide a specific attribution statement, you must use the following:
+
+Contains public sector information licensed under the Open Government Licence v3.0.
+
+If you are using Information from several Information Providers and listing multiple attributions is not practical in your product or application, you may include a URI or hyperlink to a resource that contains the required attribution statements.
+
+These are important conditions of this licence and if you fail to comply with them the rights granted to you under this licence, or any similar licence granted by the Licensor, will end automatically.
+
+Exemptions
+
+This licence does not cover:
+
+- personal data in the Information;
+
+- Information that has not been accessed by way of publication or disclosure under information access legislation (including the Freedom of Information Acts for the UK and Scotland) by or with the consent of the Information Provider;
+
+- departmental or public sector organisation logos, crests and the Royal Arms except where they form an integral part of a document or dataset;
+
+- military insignia;
+
+- third party rights the Information Provider is not authorised to license;
+
+- other intellectual property rights, including patents, trade marks, and design rights; and
+
+- identity documents such as the British Passport
+
+Non-endorsement
+
+This licence does not grant you any right to use the Information in a way that suggests any official status or that the Information Provider and/or Licensor endorse you or your use of the Information.
+
+No warranty
+
+The Information is licensed 'as is' and the Information Provider and/or Licensor excludes all representations, warranties, obligations and liabilities in relation to the Information to the maximum extent permitted by law.
+
+The Information Provider and/or Licensor are not liable for any errors or omissions in the Information and shall not be liable for any loss, injury or damage of any kind caused by its use. The Information Provider does not guarantee the continued supply of the Information.
+
+Governing Law
+
+This licence is governed by the laws of the jurisdiction in which the Information Provider has its principal place of business, unless otherwise specified by the Information Provider.
+
+Definitions
+
+In this licence, the terms below have the following meanings:
+
+'Information' means information protected by copyright or by database right (for example, literary and artistic works, content, data and source code) offered for use under the terms of this licence.
+
+'Information Provider' means the person or organisation providing the Information under this licence.
+
+'Licensor' means any Information Provider which has the authority to offer Information under the terms of this licence or the Keeper of Public Records, who has the authority to offer Information subject to Crown copyright and Crown database rights and Information subject to copyright and database right that has been assigned to or acquired by the Crown, under the terms of this licence.
+
+'Use' means doing any act which is restricted by copyright or database right, whether in the original medium or in any other medium, and includes without limitation distributing, copying, adapting, modifying as may be technically necessary to use it in a different mode or format.
+
+'You', 'you' and 'your' means the natural or legal person, or body of persons corporate or incorporate, acquiring rights in the Information (whether the Information is obtained directly from the Licensor or otherwise) under this licence.
+
+About the Open Government Licence
+
+The National Archives has developed this licence as a tool to enable Information Providers in the public sector to license the use and re-use of their Information under a common open licence. The National Archives invites public sector bodies owning their own copyright and database rights to permit the use of their Information under this licence.
+
+The Keeper of the Public Records has authority to license Information subject to copyright and database right owned by the Crown. The extent of the offer to license this Information under the terms of this licence is set out in the UK Government Licensing Framework (https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/).
+
+This is version 3.0 of the Open Government Licence. The National Archives may, from time to time, issue new versions of the Open Government Licence.  If you are already using Information under a previous version of the Open Government Licence, the terms of that licence will continue to apply.
+
+These terms are compatible with the Creative Commons Attribution License 4.0 and the Open Data Commons Attribution License, both of which license copyright and database rights.  This means that when the Information is adapted and licensed under either of those licences, you automatically satisfy the conditions of the OGL when you comply with the other licence.  The OGLv3.0 is Open Definition compliant.
+
+Further context, best practice and guidance can be found in the UK Government Licensing Framework section (https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/) on The National Archives website.

package/NOTICE

@@ -0,0 +1,34 @@
+Vulcan Community
+Copyright © 2026 Home Energy Foundry Limited and contributors.
+
+Vulcan Community was originally developed by Home Energy Foundry Limited.
+Project origin: https://usevulcan.app/open-source
+
+AGPL-covered files that refer to the Vulcan Origin Terms are licensed under
+GNU AGPL version 3 only, supplemented by ADDITIONAL_TERMS.md. Other files may be
+licensed under Apache-2.0, CC BY 4.0 or an identified upstream licence as recorded
+in licence-manifest.json and their source headers.
+
+Source repository for version 1.0.0:
+https://github.com/vulcan-energy/vulcan-community/tree/6b3e051ff93d1f5a10f3a3314ec131afef749e7e
+
+Released and modified builds must identify their exact Corresponding Source
+revision. Modified and unofficial builds must not imply affiliation with or
+endorsement by Home Energy Foundry Limited. See ATTRIBUTION.md and TRADEMARKS.md.
+
+HEM engine and FHS wrapper source included in or used to build this distribution
+remain under their canonical upstream MIT licences. The pinned HEM revision is
+62d3df705690f33b3fc3e905c9971d4f3743bf2e and the pinned FHS wrapper revision is
+c5ba2673fbd886cfe4fb528f61b376bdf406ebbd. Preserve both upstream licence
+notices in the release.
+
+The default linear thermal-transmittance values are from Home Energy Model
+guidance, Building Fabric, section 3.7.2, Table 3.7 (psi values for different
+types of junctions), published by the Department for Energy Security and Net
+Zero. Crown copyright.
+
+Contains public sector information licensed under the Open Government Licence
+v3.0. See LICENSES/OGL-UK-3.0.txt.
+
+Recognised construction details, manufacturer/exact-detail data and Vulcan
+construction packs are not part of the public distribution.

package/README.md

@@ -1,3 +1,33 @@
-# Temporary Holding Version
+<!--
+SPDX-FileCopyrightText: 2026 Home Energy Foundry Limited and contributors
+SPDX-License-Identifier: AGPL-3.0-only
+-->
 
-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.
+# Vulcan Community CLI
+
+Command-line checks for Home Energy Model (HEM) geometry, from the open-source
+[Vulcan Community](https://github.com/vulcan-energy/vulcan-community) editor. It runs
+offline on your machine.
+
+```bash
+npx @vulcan-energy/community-cli check house.csv --summary
+```
+
+| Command | What it does |
+| --- | --- |
+| `check <csv>` | Validate a geometry CSV: elements, zones, missing elements and Part F findings. `--fail-on=none\|critical\|warning` sets the exit code. |
+| `thermal-bridges <csv>` | Propose a linear thermal bridge for each junction, with Table 3.7 default psi values (`--csv-section` for a pasteable section). |
+| `thermal-bridges <csv> --validate` | Validate the CSV's thermal-bridge rows (`--with-auto` adds the proposals). |
+| `convert <csv>` | Convert a geometry CSV to HEM input JSON. Needs the Community model WASM: build from source ([Run locally](https://github.com/vulcan-energy/vulcan-community#run-locally)). |
+| `preflight <csv\|json>` | Future Homes Standard ingest and Part F preflight, without a simulation. Not a compliance result. Needs the model WASM, as `convert`. |
+| `version` | Version and legal notices. |
+
+Every command takes `--json` for machine-readable output, for scripts and AI agents. Node.js
+22.19 or later.
+
+Geometry CSVs come from the Vulcan Community editor.
+
+Licensed under AGPL-3.0-only with the Vulcan Origin Terms; see `LICENSE`, `NOTICE`,
+`ATTRIBUTION.md`, `ADDITIONAL_TERMS.md` and `TRADEMARKS.md`. Third-party material bundled in
+`dist/cli.js` is listed with its licences in `dist/THIRD_PARTY_NOTICES.md`. Source:
+<https://github.com/vulcan-energy/vulcan-community>.

package/TRADEMARKS.md

@@ -0,0 +1,31 @@
+# Vulcan trademark policy
+
+The open-source and documentation licences in this distribution do not grant
+rights to the **Vulcan**, **Vulcan Community**, **Home Energy Foundry** or related
+names, logos, service marks, trade dress or brand assets, except for factual origin
+statements required by `ATTRIBUTION.md` or uses otherwise permitted by law.
+
+## Forks and modified versions
+
+- Forks and modified products must use their own product name and branding and
+  must not imply that they are an official Vulcan product or are endorsed by Home
+  Energy Foundry Limited.
+- They must retain the factual Vulcan Community origin notice required for covered
+  AGPL material.
+- They may make truthful, plain-text statements such as “compatible with Vulcan
+  CSV”, “based on Vulcan Community” or “Powered by Vulcan”, solely as
+  factual compatibility/origin attribution and accompanied by a clear
+  non-affiliation statement.
+- They may not use Vulcan logos, confusingly similar product names or the term
+  “official” without written permission.
+
+## Certification and commercial use
+
+The **Vulcan Compatible** badge and any certification programme are separately
+licensed and may be used only after written approval. Standard proprietary
+commercial terms for the community components may require visible “Built with
+Vulcan” attribution; separately priced white-label terms may waive that contractual
+requirement. Those commercial terms are not conditions of the open-source grant.
+
+Nothing in this policy limits nominative, descriptive or other uses permitted by
+applicable law. For permissions, contact `info@usevulcan.app`.

package/dist/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,41 @@
+# Third-party notices
+
+cli.js bundles the following third-party material. polygon-clipping is a runtime dependency and carries its own licence.
+
+## Home Energy Model (HEM) input schema (data/schemas/core-input.schema.json, MIT)
+
+The MIT License (MIT)
+
+Copyright (c) 2024 Crown Copyright (Ministry of Housing, Communities and Local Government)
+
+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.
+
+## HEM Future Homes Standard wrapper input schema (data/schemas/input_fhs.schema.json, MIT)
+
+The MIT License (MIT)
+
+Copyright (c) 2026 Crown Copyright (Ministry of Housing, Communities and Local Government)
+
+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.