Skip to content
This repository has been archived by the owner on Jul 18, 2024. It is now read-only.

docs: Add note about existence of extension and how to install #131

Merged
merged 1 commit into from
Apr 5, 2023
Merged

docs: Add note about existence of extension and how to install #131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down