{"id":28506821,"url":"https://github.com/temporalio/vscode-debugger-extension","last_synced_at":"2025-07-05T04:30:57.433Z","repository":{"id":44246115,"uuid":"510890166","full_name":"temporalio/vscode-debugger-extension","owner":"temporalio","description":"Visual Studio Code debugger plugin","archived":false,"fork":false,"pushed_at":"2024-10-15T17:49:12.000Z","size":883,"stargazers_count":19,"open_issues_count":17,"forks_count":8,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-06-08T20:06:44.475Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=temporal-technologies.temporalio","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/temporalio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-07-05T20:50:38.000Z","updated_at":"2024-09-05T14:47:51.000Z","dependencies_parsed_at":"2023-02-16T23:31:07.328Z","dependency_job_id":"8d79a9db-f600-4b72-b7ca-5518399d4868","html_url":"https://github.com/temporalio/vscode-debugger-extension","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/temporalio/vscode-debugger-extension","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temporalio%2Fvscode-debugger-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temporalio%2Fvscode-debugger-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temporalio%2Fvscode-debugger-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temporalio%2Fvscode-debugger-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/temporalio","download_url":"https://codeload.github.com/temporalio/vscode-debugger-extension/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temporalio%2Fvscode-debugger-extension/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263683808,"owners_count":23495561,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-08T20:06:30.515Z","updated_at":"2025-07-05T04:30:57.427Z","avatar_url":"https://github.com/temporalio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  Temporal for VS Code\n  \u003cbr\u003e\n  \u003cbr\u003e\n    \u003cimg src=\"https://assets.temporal.io/w/vscode.png\" alt=\"Temporal for VS Code\"\u003e\n  \u003cbr\u003e\n\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003eDebug TypeScript workflows by their ID or history file.\u003c/h4\u003e\n\u003ch4 align=\"center\"\u003eSet breakpoints in code or on history events.\u003c/h4\u003e\n\n## Usage\n\nWatch [the demo](https://www.youtube.com/watch?v=3IjQde9HMNY) or follow these instructions:\n\n- Install [the extension](https://marketplace.visualstudio.com/items?itemName=temporal-technologies.temporalio)\n- Add a file at `src/debug-replayer.ts` (or can [configure](#entrypoint) an alternate location):\n\n  ```ts\n  import { startDebugReplayer } from \"@temporalio/worker\"\n\n  startDebugReplayer({\n    workflowsPath: require.resolve(\"./workflows\"),\n  })\n  ```\n\n- Edit the `'./workflows'` path to match the location of your workflows file\n- Run `Temporal: Open Panel` (use `Cmd/Ctrl-Shift-P` to open Command Palette)\n- Enter a Workflow Id or choose a history JSON file\n- Click `Start`\n- The Workflow Execution will start replaying and hit a breakpoint set on the first event\n- Set breakpoints in Workflow code (the extension uses a [replay Worker](https://typescript.temporal.io/api/classes/worker.Worker#runreplayhistory), so Activity code is not run) or on history events\n- Hit play or step forward\n- To restart from the beginning, click the green restart icon at the top of the screen, or if the debug session has ended, go back to the `MAIN` tab and `Start` again\n\n## Configuration\n\n### Server\n\nWhen starting a replay by Workflow Id, the extension downloads the history from the Temporal Server. By default, it connects to a Server running on the default `localhost:7233`.\n\nTo connect to a different Server:\n\n- Open the `SETTINGS` tab\n- Edit the `Address` field\n- If you're using TLS (e.g. to connect to Temporal Cloud), check the box and select your client cert and key\n\n### Entrypoint\n\nBy default, the extension will look for the file that calls [`startDebugReplayer`](https://typescript.temporal.io/api/namespaces/worker#startdebugreplayer) at `src/debug-replayer.ts`. To use a different TypeScript or JavaScript file, set the `temporal.replayerEntrypoint` config:\n\n- Open or create `.vscode/settings.json`\n- Add the config field:\n\n  ```json\n  {\n    \"temporal.replayerEntrypoint\": \"test/different-file.ts\"\n  }\n  ```\n\n_Note that the file must be within your project directory so it can find `node_modules/`._\n\n## Contributing\n\nThank you to [all who have contributed](https://github.com/temporalio/vscode-debugger-extension/graphs/contributors) 🙏😊. If you'd like to contribute, check out our [issues](https://github.com/temporalio/vscode-debugger-extension/issues) and [CONTRIBUTING.md](https://github.com/temporalio/vscode-debugger-extension/blob/main/CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftemporalio%2Fvscode-debugger-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftemporalio%2Fvscode-debugger-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftemporalio%2Fvscode-debugger-extension/lists"}