Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 47 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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,
Comment thread
scottisloud marked this conversation as resolved.

### 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
```

### Step 2: Tell `op` your plugins are already configured

Set `OP_PLUGIN_ALIASES_SOURCED=1` so 1Password CLI knows the shell plugins have
already been set up:

### bash / zsh

```bash
export OP_PLUGIN_ALIASES_SOURCED="1"
```

### fish
```fish
set -x OP_PLUGIN_ALIASES_SOURCED 1
```

> **Note:** `op plugin init <plugin>` 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/)