Skip to content

Commit

Permalink
docs: add note on dev/debugging via VS code
Browse files Browse the repository at this point in the history
  • Loading branch information
davidlougheed committed Mar 23, 2023
1 parent 8e5fa34 commit 1de26c1
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,16 @@ tox
coverage html
```

### Developing and debugging inside a container with VS Code (*Bento*)

The development Docker image includes metadata for the
[`devcontainer.json`](https://code.visualstudio.com/docs/devcontainers/attach-container)
specification. Using VS Code, you can attach to a running instance of a `*-dev` Katsu container
and launch the `Attach Debugger (Bento)` task to set breakpoints and step through code, as well
as interacting with and Git-committing inside the container via a remote terminal using the
pre-configured `bento_user` user, if the `BENTO_GIT_NAME` and `BENTO_GIT_EMAIL` environment
variables are set.

### Terminal Commands

Katsu ships with a variety of command-line helpers to facilitate common actions
Expand Down

0 comments on commit 1de26c1

Please sign in to comment.