> For the complete documentation index, see [llms.txt](https://docs.builtoncement.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.builtoncement.com/additional-topics/debugging-with-vscode.md).

# Debugging with VSCode

{% hint style="warning" %}
The following documentation has been adding by [community submission](https://github.com/datafolklabs/cement/issues/738), and has not yet been fully verified/tested.  Replace `<myapp>` with the Python module name of your application.
{% endhint %}

The following are notes on how to setup debugging in VSCode for applications Built on Cement. It has been tested on Cement 3.x on Windows 11.

### Implementation Steps

* Run > Open Configurations
* Run > Add Configurations
  * Select Python Debugger > Module > `<myapp>.main` &#x20;

Modify the configuration code block to allow for arguments/options:

*launch.json*

```json
"configurations": [
  {
    "name": "Python Debugger: Cement CLI Tool",
    "type": "debugpy",
    "request": "launch",
    "module": "<myapp>.main"
    "console": "integratedTerminal",
    "args": "${command:pickArgs}"
  }
]
```

The above configuration will prompt for arguments/options when Debug runs. An alternative approach might be to hard-code the arguments/options if you are frequently debugging a specific action and do not want to add it every time.

```json
"args": [ "list", "-h" ]
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.builtoncement.com/additional-topics/debugging-with-vscode.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.