{"id":32124110,"url":"https://github.com/ortus-solutions/vscode-commandbox","last_synced_at":"2026-02-18T22:01:07.452Z","repository":{"id":40402962,"uuid":"105669468","full_name":"Ortus-Solutions/vscode-commandbox","owner":"Ortus-Solutions","description":"VS Code support for CommandBox","archived":false,"fork":false,"pushed_at":"2024-09-03T22:12:00.000Z","size":1301,"stargazers_count":8,"open_issues_count":9,"forks_count":7,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-10-20T21:42:02.418Z","etag":null,"topics":["commandbox","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"","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/Ortus-Solutions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-03T15:36:36.000Z","updated_at":"2024-12-17T11:49:20.000Z","dependencies_parsed_at":"2023-01-30T03:45:42.864Z","dependency_job_id":null,"html_url":"https://github.com/Ortus-Solutions/vscode-commandbox","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/Ortus-Solutions/vscode-commandbox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ortus-Solutions%2Fvscode-commandbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ortus-Solutions%2Fvscode-commandbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ortus-Solutions%2Fvscode-commandbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ortus-Solutions%2Fvscode-commandbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ortus-Solutions","download_url":"https://codeload.github.com/Ortus-Solutions/vscode-commandbox/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ortus-Solutions%2Fvscode-commandbox/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29596328,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T20:59:56.587Z","status":"ssl_error","status_checked_at":"2026-02-18T20:58:41.434Z","response_time":162,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["commandbox","vscode","vscode-extension"],"created_at":"2025-10-20T21:40:32.462Z","updated_at":"2026-02-18T22:01:07.446Z","avatar_url":"https://github.com/Ortus-Solutions.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VS Code CommandBox extension\n\n[![VS Marketplace](https://vsmarketplacebadge.apphb.com/version-short/ortus-solutions.vscode-commandbox.svg)](https://marketplace.visualstudio.com/items?itemName=ortus-solutions.vscode-commandbox)\n[![Open VSX](https://img.shields.io/open-vsx/v/ortus-solutions/vscode-commandbox)](https://open-vsx.org/extension/ortus-solutions/vscode-commandbox)\n\nIntegrates [CommandBox](https://www.ortussolutions.com/products/commandbox) into VS Code. If you are new to CommandBox, check the [documentation](https://commandbox.ortusbooks.com/).\n\nYou are expected to have CommandBox installed on your system.\n\n## Features\n\n### Scripts\n\nThis extension supports running CommandBox scripts as [VS Code tasks](https://code.visualstudio.com/docs/editor/tasks). Scripts containing the name 'build', 'compile', or 'watch' are treated as build tasks. Any scripts defined in the `box.json` will be auto-detected by default and added as VS Code tasks. You can also annotate VS Code task definitions in your `tasks.json` files using the `type` as `commandbox` and `script` as the script name.\n\nTo run scripts as VS Code tasks, use the Task menu items or commands.\n\n#### Script Explorer\n\nThe CommandBox Script Explorer shows the CommandBox scripts found in your workspace. The explorer view is enabled by the setting `commandbox.enableScriptExplorer`. A script can be opened or run from the explorer.\n\n![CommandBox Scripts View](./images/commandbox-scripts-view.png)\n\n#### Run Scripts from the Editor\n\nThe extension supports to run the selected script as a VS Code task when editing the `box.json` file. You can either run a script from the hover shown on a script or using the command `commandbox: Run Selected Script`.\n\n![Box Script Hover](./images/box-script-hover.png)\n\n#### Run Scripts from a Folder in the Explorer\n\nThe extension supports running a script as a VS Code task from a folder in the Explorer. The command `commandbox: Run Script in Folder...` shown in the Explorer context menu finds all scripts in `box.json` files that are contained in this folder. You can then select the script to be executed as a task from the resulting list. You enable this support with the `commandbox.runScriptFromFolder` which is `false` by default.\n\n### Editing server.json\n\n#### Schema\n\nThe extension ships with a schema for the `server.json` file to provide auto-completion and information on hover for standard properties. To ensure it is kept up-to-date without having to update the extension, the latest schema in the GitHub `master` is pulled when the extension is activated.\n\n##### Property Completion\n\n![Server Completion](./images/server-completion.png)\n\n##### Property Hover\n\n![Server Hover](./images/server-hover.png)\n\n### Editing box.json\n\n#### Schema\n\nThe extension ships with a schema for the `box.json` file to provide auto-completion and information on hover for standard properties. To ensure it is kept up-to-date without having to update the extension, the latest schema in the GitHub `master` is pulled when the extension is activated.\n\n##### Property Completion\n\n![Box Completion](./images/box-completion.png)\n\n##### Property Hover\n\n![Box Hover](./images/box-hover.png)\n\n#### Dependencies\n\nThe extension also fetches data from ForgeBox to provide auto-completion and information on hover features on dependencies.\n\n##### Slug Completion\n\n![Dependency Slug Completion](./images/dependency-slug-completion.png)\n\n##### Version Completion\n\n![Dependency Version Completion](./images/dependency-version-completion.png)\n\n##### Hover\n\n![Dependency Hover](./images/dependency-hover.png)\n\n## Settings\n\n- `commandbox.autoDetect` - Enable detecting scripts as VS Code tasks. [*Default*: `on`]\n- `commandbox.exclude` - Glob patterns for folders that should be excluded from automatic script detection. The pattern is matched against the **absolute path** of the `box.json`. For example, to exclude all test folders use `**/test/**`.\n- `commandbox.enableScriptExplorer` - Enable an explorer view for CommandBox scripts when there is no top-level `box.json` file. [*Default*: `false`]\n- `commandbox.enableRunFromFolder` - Enable running CommandBox scripts from the context menu of folders in Explorer. [*Default*: `false`]\n- `commandbox.scriptExplorerAction` - The default click action: `open` or `run`. [*Default*: `open`]\n- `commandbox.buildNames` - When a VS Code task contains this as part of its name, it will be assigned as a build task. [*Default*: `[\"build\", \"compile\", \"watch\"]`]\n- `commandbox.testNames` - When a VS Code task name starts with this, it will be assigned as a test task. [*Default*: `[\"test\"]`]\n- `commandbox.scriptExplorerExclude` - An array of regular expressions that indicate which scripts should be excluded from the CommandBox Scripts view. [*Default*: `[]`]\n- `commandbox.forgebox.fetchOnlinePackageInfo` - Fetch data from ForgeBox to provide auto-completion and information on hover features on dependencies. [*Default*: `true`]\n- `commandbox.forgebox.endpointUrl` - The URL for the ForgeBox endpoint. Customize for ForgeBox Enterprise. [*Default*: `https://www.forgebox.io`]\n\n## Contributing\n\nSee [CONTRIBUTING.md](/CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fortus-solutions%2Fvscode-commandbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fortus-solutions%2Fvscode-commandbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fortus-solutions%2Fvscode-commandbox/lists"}