opencode.env 0.0.0 → 0.0.1

package/README.md

@@ -1,8 +1,16 @@
-# opencode-armor
+# opencode.env
 
-OpenCode plugin that blocks bash commands for long-running dev servers, injects
-project `.env` variables into the shell, and prepends/appends arbitrary commands
-to every bash invocation.
+OpenCode plugin that loads `.env` files and direnv environment variables into
+every shell invocation.
+
+## Features
+
+- **`.env` file loading** — Load one or more `.env` files and inject them into every shell invocation.
+- **Direnv integration** — Automatically pulls environment variables from [direnv](https://direnv.net/).
+- **Inline variable definitions** — Define `KEY: "value"` pairs directly in config.
+- **Multi-layer config** — Global (`~/.opencode.env.json`), project (`.opencode.env.json`), and opencode (`.opencode/env.json`) layers merged together.
+- **CWD support** — Automatically loads `.env` files from the current working directory when different from the project root.
+- **Selective disabling** — Independently disable global config, CWD loading, or direnv.
 
 ## Usage
 
@@ -10,7 +18,7 @@ Add to your OpenCode config (`opencode.json`):
 
 ```json
 {
-  "plugin": ["opencode-armor"]
+  "plugin": ["opencode.env"]
 }
 ```
 
@@ -19,72 +27,62 @@ Add to your OpenCode config (`opencode.json`):
 Create a config file in any of these locations. Layers are merged in this order
 (later wins and merged instead of replacing):
 
-1. `~/.opencode-armor.json` — global
-2. `./.opencode-armor.json` — project root
-3. `./.opencode/armor.json` — project root
+1. `~/.opencode.env.json` — global
+2. `./.opencode.env.json` — project root
+3. `./.opencode/env.json` — project root
 
 ```json
 {
-  "$schema": "https://github.com/NazmusSayad/opencode-armor/raw/refs/heads/schema/schema.json",
-  "armor": {
-    "priority": "whitelist",
-    "message": "Blocked: `{{COMMAND}}` (matched `{{PATTERN}}`)",
-    "blacklist": {
-      "commands": ["custom-pattern"],
-      "disableDefaults": false,
-      "disableGlobal": false
-    },
-    "whitelist": {
-      "commands": ["vitest"],
-      "disableDefaults": false,
-      "disableGlobal": false
-    }
+  "files": [".env", ".env.local"],
+  "define": {
+    "NODE_ENV": "development"
   },
-  "dotenv": {
-    "define": { "MY_VAR": "value" },
-    "files": [".env"],
-    "disableDefaults": false,
-    "disableGlobal": false,
-    "disableCwd": false
-  },
-  "command": {
-    "before": { "command": "set -e", "comment": "Fail fast" },
-    "after": { "command": "echo done", "comment": "Notify" }
-  }
+  "disableDirenv": false,
+  "disableGlobal": false,
+  "disableCwd": false
 }
 ```
 
-### `armor`
+### `files`
+
+Array of `.env`-style file paths to load (resolved relative to the project root,
+or `~/` for home directory). Variables are merged in order — later files
+override earlier ones.
+
+### `define`
+
+Inline `KEY: "value"` map of environment variables. These are merged over
+file-based variables, so they take precedence.
+
+### `disableDirenv`
 
-Controls which bash commands are blocked. Patterns are case-insensitive and
-whitespace-normalized.
+Set to `true` to skip loading environment variables from [direnv](https://direnv.net/).
 
-- `priority` — `"whitelist"` (default) or `"blacklist"`.
-- `blacklist` / `whitelist` — `commands` are substring patterns. `disableDefaults` skips the built-in list; `disableGlobal` skips the global config's list.
-- `message` — custom block error. Placeholders: `{{COMMAND}}`, `{{PATTERN}}`.
+### `disableGlobal`
 
-By default, dev servers and watchers are blocked — e.g. `npm run dev`,
-`yarn start`, `npx vite`, `npx next`, `npx nodemon`, `npx tsx watch`,
-`node --watch`, `pm2 start`. `npx next lint` is allowed by default.
+Set to `true` to ignore the global config's `files` and `define` settings.
 
-### `dotenv`
+### `disableCwd`
 
-Injects environment variables into every shell via the `shell.env` hook.
+By default, `.env` files from the current working directory are also loaded
+(if different from the project root). Set to `true` to load only from the
+project root.
 
-- `define` — inline `KEY: "value"` map merged over file-based vars.
-- `files` — additional `.env`-style files to load (resolved relative to project root, or `~/` for home).
-- `disableDefaults` — skip the built-in `.env` file list.
-- `disableGlobal` — skip the global config's `define` and `files`.
-- `disableCwd` — by default, `.env` files from the current working directory are also loaded. Set to `true` to load only from the project root.
+## How it works
 
-### `command`
+The plugin hooks into OpenCode's `shell.env` lifecycle. Before every bash
+invocation, it resolves environment variables from:
 
-Inject a command at the start or end of every bash invocation. Skipped when the
-command already starts/ends with the injected string.
+1. Inline `define` values from config (global → project → opencode)
+2. `.env` files listed in config
+3. Current working directory `.env` files (unless `disableCwd`)
+4. [direnv](https://direnv.net/) output (unless `disableDirenv`)
 
-- `before` / `after` — `{ command, comment }`. `comment` is appended after `#`.
+All resolved variables are injected into the shell environment so they are
+available to your commands.
 
 ## Debugging
 
-Set `OPENCODE_ARMOR_ENABLE_LOG=true` to write logs to
-`os.tmpdir()/.opencode-armor-logs/`.
+Set `OPENCODE_ENV_LOG_ENABLED=true` to write logs to
+`os.tmpdir()/.opencode.env-logs/`. Use `OPENCODE_ENV_LOG_PATH` to specify a
+custom log directory.