@caracal-lynx/sluice 0.1.0

package/LICENCE-FAQ.md

@@ -0,0 +1,74 @@
+# Sluice Licence FAQ
+
+Sluice is published under the **Elastic Licence 2.0 (ELv2)**. This page explains in plain English what that means for you. If in doubt, read the [full licence text](LICENSE) or contact us.
+
+---
+
+## Can I use Sluice to run data migrations for my own business?
+
+**Yes, absolutely.** If you are running Sluice internally — your own team, your own data, your own migration project — you are welcome to use it free of charge with no restrictions. That is exactly what it was built for.
+
+---
+
+## Can I use Sluice as part of an internal IT project or toolchain?
+
+**Yes.** Embedding Sluice in internal scripts, automation pipelines, or tooling used within your own organisation is permitted.
+
+---
+
+## Can I modify Sluice for my own use?
+
+**Yes.** You can fork the repository, modify the code, and run your modified version internally. You are not required to publish your changes, though contributions back to the project are always welcome.
+
+---
+
+## Can I use Sluice to deliver a data migration project for a client?
+
+**No.** Using Sluice as the basis of a commercial service delivered to third parties — for example, running Sluice pipelines on behalf of a paying client as part of a consultancy engagement — requires a commercial licence from Caracal Lynx Ltd.
+
+This restriction exists because Sluice is the core product of Caracal Lynx's data migration practice. We are happy for businesses to use it for themselves; we are not able to allow other consultancies to compete directly using our tool without an agreement in place.
+
+---
+
+## I am a consultant. Can I recommend Sluice to my clients and help them set it up?
+
+**Yes, with a distinction.** You may recommend Sluice to clients and help them understand it. The restriction applies when Sluice is central to a commercial service *you* are delivering — i.e. you are operating or running pipelines on the client's behalf as a paid engagement. If the client is operating Sluice themselves after your initial help, that is their internal use and is permitted.
+
+If you are unsure whether your situation requires a commercial licence, please contact us — we would rather clarify upfront than create problems later.
+
+---
+
+## Can I resell Sluice or white-label it as my own product?
+
+**No.** Reselling, repackaging, or white-labelling Sluice — with or without modifications — is not permitted under ELv2.
+
+---
+
+## Can I write and publish plugins or adapters for Sluice?
+
+**Yes.** Building and publishing `sluice-adapter-*` or `sluice-plugin-*` packages on npm is encouraged. The restriction on commercial use applies to Sluice itself; it does not prevent you from building and selling plugins or adapters as separate products, provided those products do not effectively replicate Sluice's core functionality.
+
+---
+
+## Can I contribute to the Sluice codebase?
+
+**Yes, and thank you.** Pull requests are welcome. By submitting a contribution you agree that your code is licenced under the same ELv2 terms as the rest of the project, and that Caracal Lynx Ltd. retains the right to include it in future releases (including any future commercial releases).
+
+---
+
+## What if I want to use Sluice commercially?
+
+Contact us. We offer commercial licences for consultancies and service providers who want to use Sluice as part of a paid offering. Pricing is by arrangement and depends on the nature and scale of use.
+
+📧 **michael.scott@caracallynx.com**
+🌐 **Caracal Lynx Ltd.** — registered in Scotland, SC826823
+
+---
+
+## Is this "open source"?
+
+Technically, no. The Elastic Licence 2.0 is a *source available* licence — the code is fully public, you can read it, fork it, and use it for internal purposes, but it does not meet the OSI definition of "open source" because of the restriction on commercial service use. We have chosen this approach to keep Sluice accessible to businesses while protecting the consultancy practice that funds its development.
+
+---
+
+*This FAQ is a plain-English guide and does not constitute legal advice. The [LICENSE](LICENSE) file is the authoritative legal text. Last updated: April 2026.*

package/LICENSE

@@ -0,0 +1,92 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject
+to the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set
+of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other
+notices of the licensor in the software. Any use of the licensor's trademarks
+is subject to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If your company
+makes such a claim, your patent license ends immediately for work on behalf
+of your company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from
+you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license
+no later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your
+licenses to terminate automatically and permanently.
+
+## No Liability
+
+As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is
+the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that organization.
+**Control** means ownership of substantially all the assets of an entity, or
+the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.
+
+**Trademark** means trademarks, service marks, and similar rights.