From 21c66fae7523bef4d6c4e9d52ebc82beab42aeda Mon Sep 17 00:00:00 2001 From: James McTavish Date: Wed, 5 Apr 2023 16:24:57 -0400 Subject: [PATCH] docs: Add note about existence of extension and how to install --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 6447bb8..8e65f70 100644 --- a/README.md +++ b/README.md @@ -674,6 +674,23 @@ Deleted 4 snapshots. ``` +## VSCode Extension + +There is a VSCode extension for the Snapshot Debugger. You can use this +extension to set logpoints, set breakpoints and view snapshots in the comfort +of your IDE. See the [extension's README][extension-readme] for more details. + +You can install the extension by downloading it from the +[most recent release][extension-release], and then running +`code --install-extension snapshotdbg-*.vsix`. + +Note that you will still need to use the Snapshot Debugger CLI to set up your +environment and to purge old data. Gcloud needs to be installed for credential +management. + +[extension-release]: https://github.com/GoogleCloudPlatform/snapshot-debugger/releases +[extension-readme]: https://github.com/GoogleCloudPlatform/snapshot-debugger/blob/main/snapshot_dbg_extension/README.md + ## Troubleshooting See [Snapshot Debugger Troubleshooting][troubleshooting]