@wrkspace-co/env 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 wrkspace.co
+
+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

@@ -0,0 +1,107 @@
+<div align="center">
+  <h1>Airlock (Wrkspace Env)</h1>
+  <p>
+    <img alt="Release" src="https://img.shields.io/github/v/release/wrkspace-co/env" />
+    <img alt="CI" src="https://img.shields.io/github/actions/workflow/status/wrkspace-co/env/ci.yml" />
+    <a href="https://badge.socket.dev/npm/package/@wrkspace-co/env">
+      <img alt="Socket" src="https://badge.socket.dev/npm/package/@wrkspace-co/env" />
+    </a>
+    <img alt="License" src="https://img.shields.io/github/license/wrkspace-co/env" />
+    <img alt="Stars" src="https://img.shields.io/github/stars/wrkspace-co/env" />
+  </p>
+</div>
+
+Airlock `(@wrkspace-co/env)` is a migration-first environment contract system for Node.js projects.
+You define env evolution with TypeScript migrations, then generate schema/docs/artifacts and validate targets (`dev`, `preview`, `prod`) from a single source of truth.
+
+**Docs:** [https://wrkspace-co.github.io/env/](https://wrkspace-co.github.io/env/)
+
+## Benefits
+- **Single source of truth.** Your env contract lives in `env/migrations/*.ts`, not scattered `.env*` files.
+- **Safe iterative changes.** Add, rename, deprecate, and remove keys with reviewable migration history.
+- **CI-ready validation.** Run strict checks with stable JSON output for automation.
+
+## Features
+- Chain-based migration API (`ctx.key(...).define(...).value(...).remove()`)
+- Migration integrity and rollback support
+- Generated artifacts: `.env*`, `env/schema.generated.json`, `env/ENV.md`, `env/env.audit.json`
+- Environment validation, audit, and deprecation checks
+- Provider sync/diff/export workflows (Vercel/Heroku + export formats)
+- TypeScript-first
+
+## Install
+```bash
+pnpm add -D @wrkspace-co/env
+```
+
+If you also use the Wrkspace wrapper, install both packages:
+```bash
+pnpm add -D @wrkspace-co/cli @wrkspace-co/env
+```
+
+## Quick start
+1. Create migration:
+```bash
+airlock migrate:make bootstrap-env
+```
+
+2. Edit migration:
+```ts
+import type { EnvMigrationContext } from "@wrkspace-co/env";
+
+export async function up(ctx: EnvMigrationContext) {
+  ctx.setPrefixPolicy("nextjs");
+
+  ctx.url("DATABASE_URL")
+    .scope("server")
+    .requiredIn("prod");
+
+  ctx.url("NEXT_PUBLIC_SITE_URL")
+    .scope("client")
+    .requiredIn(["dev", "preview", "prod"])
+    .value("https://example.com");
+
+  ctx.enum("LOG_LEVEL")
+    .values(["debug", "info", "warn", "error"])
+    .requiredIn(["dev", "preview", "prod"])
+    .defaultValue("info");
+
+  ctx.string("OLD_TOKEN")
+    .requiredIn("prod")
+    .deprecate("NEW_TOKEN", "2026-12-31", "Rotate to NEW_TOKEN");
+}
+
+export async function down(ctx: EnvMigrationContext) {
+  ctx.key("DATABASE_URL").remove();
+  ctx.key("NEXT_PUBLIC_SITE_URL").remove();
+  ctx.key("LOG_LEVEL").remove();
+  ctx.key("OLD_TOKEN").remove();
+  ctx.setPrefixPolicy(undefined);
+}
+```
+
+3. Apply migrations:
+```bash
+airlock migrate
+```
+
+4. Validate target:
+```bash
+airlock check --target prod --json
+```
+
+## Common commands
+```bash
+airlock migrate:status --json
+airlock generate --write-local --write-target-files
+airlock audit --json
+airlock deprecations --json
+```
+
+`wrkspace env <cmd>` and `airlock <cmd>` use the same command handlers and options.
+
+## Learn more
+[Full documentation](https://wrkspace-co.github.io/env/)
+
+**Credits**
+Airlock is a part of [Wrkspace Co.](https://wrkspace.co) &copy; group.