diff --git a/README.md b/README.md index c95ebda..faa3067 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,21 @@ Specify in your workflow YAML file which secrets from 1Password should be loaded Read more on the [1Password Developer Portal](https://developer.1password.com/docs/ci-cd/github-actions). +## 🔑 SSH Key Format + +When loading SSH keys, you can specify the format using the `ssh-format` query parameter. This is useful when you need the private key in a specific format like OpenSSH. + +```yml +- name: Load SSH key + uses: 1password/load-secrets-action@v3 + env: + OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }} + # Load SSH private key in OpenSSH format + SSH_PRIVATE_KEY: op://vault/item/private key?ssh-format=openssh +``` + +For more details on secret reference syntax, see the [1Password CLI documentation](https://developer.1password.com/docs/cli/secret-reference-syntax/#ssh-format-parameter). + ## 🪄 See it in action! [![Using 1Password Service Accounts with GitHub Actions - showcase](https://img.youtube.com/vi/kVBl5iQYgSA/maxresdefault.jpg)](https://www.youtube.com/watch?v=kVBl5iQYgSA "Using 1Password Service Accounts with GitHub Actions")