VSCode SOPS extension
The homepage of VSCode extension is located on https://github.com/signageos/vscode-sops
Extension for VSCode is available on market place https://marketplace.visualstudio.com/items?itemName=signageos.signageos-vscode-sops
Additionally, it's available on Open VSX market place https://open-vsx.org/extension/signageos/signageos-vscode-sops
VSCode extension with underlying SOPS supports:
- Realtime editing of encrypted
ini files in-place in your project.
- Create new encrypted yaml/json file using
.sops.yaml config creation_rules if available.
Make sure that
sops is available in $PATH environment variable
sops.enable: enable/disable this extension (default: true)
sops.beta: enable/disable beta release without reloading VSCode or enabling/disabling extensions (default: false)
sops.binPath: Path to SOPS binary (default: executables from
sops.configPath: Path (absolute or relative) to the configuration for this extension (empty: defaults to
.sopsrc in root of project) See Config file section.
sops.defaults.awsProfile: Default AWS profile name which will be used for sops command
--aws-profile (empty: defaults to environment variable
sops.defaults.gcpCredentialsPath: Default path used to find GCP credentials. Overrides the
$GOOGLE_APPLICATION_CREDENTIALS environment variable (empty: defaults to environment variable
sops.defaults.ageKeyFile: Default path used to find AGE key file. Overwrites the
$SOPS_AGE_KEY_FILE environment variable (default: uses from environment variable
sops.creationEnabled: enable/disable this extension to try encrypt files included in .sops.yaml path_regex when is not encrypted yet (default: false)
.sopsrc in project root by default and is in YAML format.
The new features are published immediately into different extension package https://marketplace.visualstudio.com/items?itemName=signageos.signageos-vscode-sops-beta
The beta extension package is installed automatically and is disabled by default.
If you'd like to try new features, just enable configuration
"sops.beta": true in global (or workspace) config file and changes are applied immediately.
You can switch beta configuration globally easily using commands
I recommend to have enabled beta release to test everything as soon as possible. If something went wrong in beta release, just easily rollback to
"sops.beta" false and report an issue here: https://github.com/signageos/vscode-sops/issues
The reason is that vscode doesn't support beta releases built-in. See and vote for https://github.com/microsoft/vscode/issues/15756
Optionally, you can add following file
.gitattributes into your project
and run following command for global git settings
git config --global diff.sopsdiffer.textconv "sops -d --config /dev/null"
to see the git diff in decrypted format.
See https://github.com/signageos/vscode-sops/blob/master/CHANGELOG.md file.