From 20cad04987ca654584683173f061d083e18b773a Mon Sep 17 00:00:00 2001 From: Scott Lougheed Date: Tue, 2 Jun 2026 09:38:49 -0700 Subject: [PATCH 1/3] appending advanced configuration to readme --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d20e51a6d..8c9bcada5 100644 --- a/README.md +++ b/README.md @@ -63,8 +63,54 @@ Still not sure where or how to begin? We're happy to help! You can: - Book a free [pairing session](https://calendly.com/d/grs-x2h-pmb/1password-shell-plugins-pairing-session) with one of our developers - Join the [Developer Slack workspace](https://developer.1password.com/joinslack), and ask us any questions there +## Advanced Configuration +### Managing shell plugins in your own dotfiles + +By default, `op plugin init` writes its configuration to `~/.config/op/plugins.sh` +and manages that file for you. If you'd rather keep your plugin configuration in +your own dotfiles (for example, tracked in version control), you can define the +shell functions yourself instead. + +### 1. Define the plugin functions +Shell functions for each shell should follow this pattern. In this case, + +### bash / zsh + +```bash +gh() { + op plugin run -- gh "$@" +} +``` + +### fish + +```fish +function gh --wraps gh --description "1Password shell plugin for GitHub CLI" + op plugin run -- gh $argv +end +``` + +### 2. Tell `op` your plugins are already configured + +Set `OP_PLUGINS_SOURCED=1` so the 1Password CLI knows the shell plugins have +already been set up: + +### bash / zsh + +```bash +export OP_PLUGINS_SOURCED="1" +``` + +### fish +```fish +set -x OP_PLUGINS_SOURCED 1 +``` + +> **Note:** `op plugin init ` edits `~/.config/op/plugins.sh` directly and won't update your own dotfiles, so configure plugins manually as shown above. + + ## 💙 Community & Support - File an [issue](https://github.com/1Password/shell-plugins/issues/new/choose) for bugs and feature requests - Join the [Developer Slack workspace](https://developer.1password.com/joinslack) -- Subscribe to the [Developer Newsletter](https://1password.com/dev-subscribe/) +- Subscribe to the [Developer Newsletter](https://1password.com/dev-subscribe/) \ No newline at end of file From ee527c0bf4a2e2bd1c7d6012a3caa8ed2b6f99e2 Mon Sep 17 00:00:00 2001 From: Scott Lougheed Date: Tue, 2 Jun 2026 15:01:45 -0700 Subject: [PATCH 2/3] correcting headings --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8c9bcada5..a9c61692e 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ and manages that file for you. If you'd rather keep your plugin configuration in your own dotfiles (for example, tracked in version control), you can define the shell functions yourself instead. -### 1. Define the plugin functions +### Step 1: Define the plugin functions Shell functions for each shell should follow this pattern. In this case, ### bash / zsh @@ -90,9 +90,9 @@ function gh --wraps gh --description "1Password shell plugin for GitHub CLI" end ``` -### 2. Tell `op` your plugins are already configured +### Step 2: Tell `op` your plugins are already configured -Set `OP_PLUGINS_SOURCED=1` so the 1Password CLI knows the shell plugins have +Set `OP_PLUGINS_SOURCED=1` so 1Password CLI knows the shell plugins have already been set up: ### bash / zsh From af296509a0a837081bce8f5e9fd460b2aff5804b Mon Sep 17 00:00:00 2001 From: Scott Lougheed Date: Tue, 2 Jun 2026 15:05:20 -0700 Subject: [PATCH 3/3] correcting env value and adding details to instructions --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a9c61692e..e0d0a01ec 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ Still not sure where or how to begin? We're happy to help! You can: By default, `op plugin init` writes its configuration to `~/.config/op/plugins.sh` and manages that file for you. If you'd rather keep your plugin configuration in your own dotfiles (for example, tracked in version control), you can define the -shell functions yourself instead. +shell functions yourself and source them in your shell's configuration file. ### Step 1: Define the plugin functions Shell functions for each shell should follow this pattern. In this case, @@ -92,18 +92,18 @@ end ### Step 2: Tell `op` your plugins are already configured -Set `OP_PLUGINS_SOURCED=1` so 1Password CLI knows the shell plugins have +Set `OP_PLUGIN_ALIASES_SOURCED=1` so 1Password CLI knows the shell plugins have already been set up: ### bash / zsh ```bash -export OP_PLUGINS_SOURCED="1" +export OP_PLUGIN_ALIASES_SOURCED="1" ``` ### fish ```fish -set -x OP_PLUGINS_SOURCED 1 +set -x OP_PLUGIN_ALIASES_SOURCED 1 ``` > **Note:** `op plugin init ` edits `~/.config/op/plugins.sh` directly and won't update your own dotfiles, so configure plugins manually as shown above.