Skip to main content
Public Preview The Wherobots VS Code Extension brings job submission directly into your editor. Submit the current .py file to Wherobots Cloud from the Command Palette with configurable runtime, region, timeout, and arguments. Monitor progress and review results alongside your code. The extension pre-fills the submission form from settings you write as comments in the file, so the settings stay with your code and in version control. See Inline job configuration.

​
Before you start

Ensure you have the following:

​
Submit a job

1

Open a Python file. This file will be submitted as a job run.

Open a saved Python file (.py) in your editor that contains the code you want to run as a job. This file can also include inline job configuration comments to pre-fill submission defaults.
2

Open the Command Palette

To open the Command Palette, click the search bar at the top of your editor and type >wherobots:.Command Palette
You can also press ⌘ + Shift + P on Mac, Ctrl + Shift + P on Windows/Linux to open the Command Palette.
3

Select the Submit Job command

Type Wherobots and select Wherobots: Submit Job.Command Palette
4

Confirm job options

Confirm job options in the submission form — including Runtime, Region, Arguments, and Timeout.You can pass the local path to your Python file as an Argument.
5

Submit the job

Submit the job. Use the Open Job action from the success notification to track the job in the Wherobots Cloud Console.
Job runs execute on Wherobots Cloud infrastructure and appear in Usage History. For more information on job runs, see Job Runs REST API.

​
Inline job configuration

You can provide job defaults directly in your Python file using special comments. The extension reads these comments and pre-fills the submission form:

​
Supported keys

The following comment keys are supported for inline job configuration:

​
Cost considerations

Job runs are billed based on runtime size and duration. See Runtimes for pricing details. Confirm your Organization has sufficient Spatial Unit allocation before submitting jobs.

​
Troubleshooting

If you encounter issues submitting jobs from the Wherobots VS Code Extension, refer to the following troubleshooting tips:
  • Ensure the Wherobots VS Code Extension is installed and configured with your API key.
  • Check that the script path is valid and the file is accessible.
  • Review the Output panel for error details.
  • Confirm your Organization has sufficient Spatial Unit allocation.
  • Job submission only supports saved .py files
  • Save untitled files and confirm the file extension is .py before running Wherobots: Submit Job
  • Set wherobotsjobsubmit.scriptPath in your editor’s Settings to an explicit managed path if needed
  • If left empty, the extension derives a managed default path for your user