Thanks for your interest in contributing to the 1Password Shell Plugins project! 🙌
The only way we can make plaintext secrets in the home directory a thing of the past and get the widest coverage of shell plugins is by making this a community effort.
This document contains useful information and guidelines for everyone interested in contributing to the project.
If you're planning to create your first plugin, we recommend you have a look at the step-by-step guide in the 1Password developer docs first, which explains the basic concepts of the plugin ecosystem and walks you through the creation of your first plugin.
The current focus of 1Password Shell Plugins is to cover CLIs that require authentication to their platform's backend. Examples of that are CLIs provided by SaaS platforms, cloud vendors, and databases.
Unofficial CLIs are less likely to get accepted at this moment.
CLIs that authenticate to multiple different platforms depending on the project are also out of scope at this stage.
Examples include terraform, ansible, or the CLIs that come with application development frameworks (flask run, spring run, etc.).
Try to avoid bringing in third-party dependencies if possible. Especially when building importers for your plugin, all that's needed in most cases is to read a file on disk, for which the shell plugins SDK already provides helpers.
PRs that introduce new dependencies will take longer to get through the review process and have a higher chance of getting rejected.
To get your PR merged, we require you to sign your commits. Fortunately, this has become very easy to set up!
The plugin ecosystem allows you to locally build your plugins and use them with 1Password CLI, so you can take your plugin for a spin before submitting a PR.
You can add tests to your plugin using the SDK's plugintest package, which provides helpers so that you only have to care about the test cases themselves.
You can use the example-secrets command to help create test fixtures.
This repo comes with a set of make commands to make your life as a contributor easier.
Bootstrap a new plugin package based on a few prompts to fill in:
make new-plugin
Validate the schema of a plugin and prints out a report of all validation checks that were done:
make <plugin>/validate
Locally build a plugin and install it in the ~/.op/plugins/local directory:
make <plugin>/build
Note: Locally built plugins take precedence over existing plugins. This allows you to customize existing plugins.
Automatically generate example values for all secrets defined in a plugin:
make <plugin>/example-secrets
No documentation work is required on your end. If your plugin is accepted, a technical writer on our team will publish a guide to using your plugin when the plugin is added to 1Password CLI. You can help the technical writing team by:
- Making note in your PR of anything unique to your shell plugin that might need to be documented beyond our standard template.
- Including an example command that requires authentication for us to use in our testing and screenshots.
If you need help, found a bug, or have an idea for an awesome plugin that you'd like to discuss with us first, you can reach out to us here:
- Create an issue in this repo.
- Join the Developer Slack workspace.
The 1Password Shell Plugins ecosystem is still in beta. In practice, this means that if you're building your own plugins locally, you'll likely have to recompile them on occasion to keep up with the latest updates of the 1Password CLI.