@envin/cli 0.0.1 → 1.1.1

package/CHANGELOG.md

@@ -0,0 +1,32 @@
+# @envin/cli
+
+## 1.1.1
+
+### Patch Changes
+
+- [#22](https://github.com/turbostarter/envin/pull/22) [`5d278e1`](https://github.com/turbostarter/envin/commit/5d278e16b0ad7557c021bfd445ce0527727125c2) Thanks [@Bartek532](https://github.com/Bartek532)! - Minor enhancements and fixes
+
+- Updated dependencies [[`5d278e1`](https://github.com/turbostarter/envin/commit/5d278e16b0ad7557c021bfd445ce0527727125c2)]:
+  - envin@1.1.1
+
+## 1.1.0
+
+### Minor Changes
+
+- [#20](https://github.com/turbostarter/envin/pull/20) [`bd7f32f`](https://github.com/turbostarter/envin/commit/bd7f32fd796af56ffa0bdb986c681a9c9d41a8d3) Thanks [@Bartek532](https://github.com/Bartek532)! - Setup hot reloading for live preview
+
+### Patch Changes
+
+- Updated dependencies [[`bd7f32f`](https://github.com/turbostarter/envin/commit/bd7f32fd796af56ffa0bdb986c681a9c9d41a8d3)]:
+  - envin@1.1.0
+
+## 1.0.0
+
+### Major Changes
+
+- [`a0c59f1`](https://github.com/turbostarter/envin/commit/a0c59f1a12f8ad08096fcb68548cae7c622e8acf) Thanks [@Bartek532](https://github.com/Bartek532)! - Prepare documentation for the first release
+
+### Patch Changes
+
+- Updated dependencies [[`a0c59f1`](https://github.com/turbostarter/envin/commit/a0c59f1a12f8ad08096fcb68548cae7c622e8acf)]:
+  - envin@1.0.0

package/README.md

@@ -0,0 +1,95 @@
+![Envin](./apps/docs/src/app/opengraph-image.png)
+
+## Installation
+
+> [!NOTE]
+>
+> This is an ESM only package that requires a tsconfig with a module resolution that can read package.json#exports (`NodeNext` if transpiling with `tsc`, `Bundler` if using a bundler).
+
+```bash
+# Core package, no framework specific features
+bun add envin
+
+# CLI, used e.g. for live previews
+bun add @envin/cli
+```
+
+For full documentation, see https://envin.turbostarter.dev
+
+## Usage
+
+> [!NOTE]
+>
+> You may use any [Standard Schema](https://github.com/standard-schema/standard-schema) compliant validator of your choice.
+
+This package supports the full power of [most popular schema libraries](https://github.com/standard-schema/standard-schema?tab=readme-ov-file#what-schema-libraries-implement-the-spec), meaning you can use `transforms` and `default` values.
+
+### Define your schema
+
+```ts
+// env.config.ts
+import { defineEnv } from "envin";
+import { z } from "zod";
+
+export default defineEnv({
+  /*
+   * Shared environment variables, available on the client and server.
+   */
+  shared: {
+    NODE_ENV: z.enum(["development", "production"]).default("development"),
+  },
+  /*
+   * Prefix for client environment variables.
+   */
+  clientPrefix: "NEXT_PUBLIC_",
+  /*
+   * Environment variables available on the client (and server).
+   *
+   * 💡 You'll get type errors if these are not prefixed with NEXT_PUBLIC_.
+   */
+  client: {
+    NEXT_PUBLIC_API_URL: z.string().url(),
+  },
+  /*
+   * Serverside Environment variables, not available on the client.
+   * Will throw if you access these variables on the client.
+   */
+  server: {
+    DATABASE_URL: z.string().url(),
+  },
+  /*
+   * In some cases, we need to manually destructure environment variables to make sure all are included in bundle.
+   *
+   * 💡 You'll get type errors if not all variables are included here.
+   */
+  envStrict: {
+    DATABASE_URL: process.env.DATABASE_URL,
+    NEXT_PUBLIC_API_URL: process.env.NEXT_PUBLIC_API_URL,
+  },
+});
+```
+
+### Use the schema in your app with autocompletion and type inference
+
+```ts
+// route.ts
+import env from "~/env.config";
+
+export const GET = (req: Request) => {
+  const DATABASE_URL = env.DATABASE_URL;
+  // use it...
+};
+```
+
+## Live Preview
+
+One of the most powerful features of this package is the ability to preview your environment variables in a livemode.
+
+```bash
+# Run the CLI with your env.config.ts file
+npx @envin/cli@latest dev
+```
+
+![Live Preview](./apps/docs/public/images/docs/live-preview.png)
+
+This will start a live preview server that will automatically update your environment variables when you change them allowing you to find and fix errors before deploying your app.