@qui-cli/env-1password 1.0.4 → 1.1.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [1.1.0](https://github.com/battis/qui-cli/compare/env-1password/1.0.5...env-1password/1.1.0) (2025-12-19)
+
+
+### Features
+
+* opAccount and opToken args for env-1password (if 1Password CLI present) ([c107a88](https://github.com/battis/qui-cli/commit/c107a884d661e324e46c1bfd2d561934f5694de6))
+
+## [1.0.5](https://github.com/battis/qui-cli/compare/env-1password/1.0.4...env-1password/1.0.5) (2025-11-12)
+
+
+### Bug Fixes
+
+* boost standard headig back to level 1 ([cfb3065](https://github.com/battis/qui-cli/commit/cfb30657a3d719df60663d0a8e6aa6cf240740e9))
+
 ## [1.0.4](https://github.com/battis/qui-cli/compare/env-1password/1.0.3...env-1password/1.0.4) (2025-11-08)
 
 

package/README.md

@@ -62,18 +62,40 @@ Whether or not to load the `.env` file into `process.env` immediately. Defaults
 
 Path to desired `.env` file relative to `root`. Defaults to `'.env'`;
 
+### `opToken`
+
+1Password service account token
+
+### `opItem`
+
+Name or ID of the 1Password API Credential item storing the 1Password service account token
+
+### `opAccount`
+
+1Password account to use (if signed into multiple)
+
 ## Options
 
-`Env` adds no user-configurable command line options.
+The configuration options `opToken`, `opItem`, and `opAccount` may all be passed as command-line options. For example:
+
+```sh
+example --opToken "$(op item get ServiceAccountToken)"
+```
+
+If the [1Password CLI tool](https://developer.1password.com/docs/cli) is installed, then `opItem` and `opAccount` can be used:
+
+```sh
+example --opItem ServiceAccountToken
+```
 
 ## Initialization
 
-`Env` requires no initialization
+`Env` loads the specified `.env` file into `process.env`. If 1Password secret references are found in the environment, those references are loaded into the `process.env` from the 1Password vault (if a service account token is provided).
 
 ## API
 
 ```ts
-import { Env } from '@qui-cli/env';
+import { Env } from '@qui-cli/env-1password';
 ```
 
 ### `Env.parse(file?)`

package/dist/1Password.d.ts

@@ -1,10 +1,20 @@
 import { Env } from '@qui-cli/env';
 import * as Plugin from '@qui-cli/plugin';
 export type Configuration = Plugin.Configuration & Env.Configuration & {
+    /** 1Password service account token */
+    opToken?: string;
+    /**
+     * Name or ID of the 1Password API Credential item storing the 1Password
+     * service account token
+     */
+    opItem?: string;
+    /** 1Password account to use (if signed into multiple) */
+    opAccount?: string;
+    /** @deprecated Use {@link opToken} */
     serviceAccountToken?: string;
 };
 export declare const name = "env-1password";
-export declare function configure(config?: Configuration): Promise<void>;
+export declare function configure(proposal?: Configuration): Promise<void>;
 export declare function options(): Plugin.Options;
 export declare function init({ values }: Plugin.ExpectedArguments<typeof options>): Promise<void>;
 export declare function parse(file?: string): Promise<import("dotenv").DotenvParseOutput>;

package/dist/1Password.js

@@ -1,25 +1,47 @@
 import { createClient } from '@1password/sdk';
 import { importLocal } from '@battis/import-package-json';
+import { Colors } from '@qui-cli/colors';
 import { Env } from '@qui-cli/env';
+import { Log } from '@qui-cli/log';
+import { Shell } from '@qui-cli/shell';
 import path from 'node:path';
 export const name = 'env-1password';
 let client = undefined;
-export async function configure(config = {}) {
-    const { serviceAccountToken, load = true, ...rest } = config;
-    await Env.configure({ ...rest, load: false });
-    const auth = serviceAccountToken;
-    if (auth) {
+const config = {};
+export async function configure(proposal = {}) {
+    for (const key in proposal) {
+        if (proposal[key] !== undefined) {
+            config[key] = proposal[key];
+        }
+    }
+    config.opToken = config.opToken || config.serviceAccountToken;
+    await Env.configure({ ...config, load: false });
+    if (config.opItem && !config.opToken) {
+        const silent = Shell.isSilent();
+        const showCommands = Shell.commandsShown();
+        Shell.configure({ silent: true, showCommands: false });
+        const { stdout, stderr } = Shell.exec(`op item get ${config.opAccount ? `--account "${config.opAccount}" ` : ''}--reveal "${config.opItem}"`);
+        if (stdout.length) {
+            config.opToken = stdout;
+        }
+        else {
+            Log.fatal(stderr);
+            process.exit(1);
+        }
+        Shell.configure({ silent, showCommands });
+    }
+    if (config.opToken) {
         const pkg = await importLocal(path.join(import.meta.dirname, '../package.json'));
         client = await createClient({
-            auth,
+            auth: config.opToken,
             integrationName: pkg.name.replace(/^(\/|@)/, '').replace(/[/@]+/g, '-'),
             integrationVersion: pkg.version
         });
-        if (load) {
+        if (config.load) {
             await parse();
         }
     }
-    else if (load) {
+    else if (config.load) {
         await Env.parse();
     }
 }
@@ -27,14 +49,37 @@ export function options() {
     return {
         man: [
             {
-                level: 3,
-                text: '1Password integration'
-            }
+                level: 1,
+                text: '1Password environment integration'
+            },
+            {
+                text: 'Store 1Password secret references in your environment, rather than the actual secrets.'
+            },
+            {
+                text: `If 1Password secret references are stored in the environment, a 1Password service account token is required to access the secret values, which will be loaded into ${Colors.value('process.env')}. The service account token can be passed directly as the ${Colors.optionArg('--opToken')} argument (e.g. ${Colors.command(`${Colors.keyword('example')} --opToken "(${Colors.keyword('op')} item get SERVICE_ACCOUNT_TOKEN)"`)}) or, if the 1Password CLI tool is also installed, by simply passing the name or ID of the API Credential in your 1Password vault that holds the service account token (e.g. ${Colors.command(`${Colors.keyword('example')} --opItem SERVICE_ACCOUNT_TOKEN`)}). If you are signed into multiple 1Password account, use the ${Colors.optionArg('--opAccount')} argument to specify the account containing the token.`
+            },
+            { text: Colors.url('https://developer.1password.com/docs/cli') }
         ],
         opt: {
+            opAccount: {
+                description: `1Password account to use (if signed into multiple)`,
+                hint: 'example.1password.com',
+                default: config.opAccount
+            },
+            opItem: {
+                description: `Name or ID of the 1Password API Credential item storing the 1Password service account token`,
+                default: config.opItem
+            },
+            opToken: {
+                description: `1Password service account token`,
+                secret: true,
+                default: config.opToken || config.serviceAccountToken
+            },
             serviceAccountToken: {
-                description: `1Password service account token (required if any secret references are present in the environment)`,
-                secret: true
+                description: `1Password service account token`,
+                hint: 'Deprecated',
+                secret: true,
+                default: config.serviceAccountToken
             }
         }
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qui-cli/env-1password",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "@qui-cli Plugin: Standardized environment configuration",
   "homepage": "https://github.com/battis/qui-cli/tree/main/packages/env-1password#readme",
   "repository": {
@@ -22,15 +22,18 @@
     "dotenv": "^17.2.3"
   },
   "devDependencies": {
-    "@tsconfig/node20": "^20.1.6",
-    "@types/node": "^24.10.0",
-    "commit-and-tag-version": "^12.6.0",
+    "@tsconfig/node20": "^20.1.8",
+    "@types/node": "^24.10.3",
+    "commit-and-tag-version": "^12.6.1",
     "del-cli": "^6.0.0",
     "npm-run-all": "^4.1.5",
     "typescript": "^5.9.3",
-    "@qui-cli/env": "5.0.0",
+    "@qui-cli/env": "5.0.2",
+    "@qui-cli/colors": "3.1.1",
     "@qui-cli/plugin": "4.0.0",
-    "@qui-cli/root": "3.0.3"
+    "@qui-cli/log": "4.0.1",
+    "@qui-cli/root": "3.0.4",
+    "@qui-cli/shell": "3.0.3"
   },
   "peerDependencies": {
     "@qui-cli/env": "5.x",