@@ -64,9 +64,9 @@ You can use specially crafted JetBrains Gateway URIs to automatically:
64
64
### Example URIs
65
65
66
66
``` text
67
- jetbrains://gateway/com.coder.toolbox?url=https%3A%2F%2Fdev.coder.com&token=abaC5SbSpP-J2qGpajkdreR9jBdcekXS2 &workspace=bobiverse-bob&ide_product_code=GO&ide_build_number=241.23774.119&folder=%2Fhome%2Fcoder%2Fworkspace%2Fhello-world-rs
67
+ jetbrains://gateway/com.coder.toolbox?url=https%3A%2F%2Fdev.coder.com&token=zeoX4SbSpP-j2qGpajkdwxR9jBdcekXS2 &workspace=bobiverse-bob&agent=dev &ide_product_code=GO&ide_build_number=241.23774.119&folder=%2Fhome%2Fcoder%2Fworkspace%2Fhello-world-rs
68
68
69
- jetbrains://gateway/com.coder.toolbox?url=https%3A%2F%2Fj5gj2r1so5nbi.pit-1.try.coder.app%2F&token=gqEirOoI1U-FfCQ6uj8iOLtybBIk99rr8&workspace=bobiverse-bill &ide_product_code=RR&ide_build_number=243.26053.17&folder=%2Fhome%2Fcoder%2Fworkspace%2Fhello-world-rs
69
+ jetbrains://gateway/com.coder.toolbox?url=https%3A%2F%2Fj5gj2r1so5nbi.pit-1.try.coder.app%2F&token=gqEirOoI1U-FfCQ6uj8iOLtybBIk99rr8&workspace=bobiverse-riker&agent=dev &ide_product_code=RR&ide_build_number=243.26053.17&folder=%2Fhome%2Fcoder%2Fworkspace%2Fhello-world-rs
70
70
```
71
71
72
72
### URI Breakdown
@@ -76,32 +76,35 @@ jetbrains://gateway/com.coder.toolbox
76
76
?url=http(s)://<your-coder-deployment>
77
77
&token=<auth-token>
78
78
&workspace=<workspace-name>
79
+ &agent/agent_id=<agent-name-or-agent-id>
79
80
&ide_product_code=<IDE-code>
80
81
&ide_build_number=<IDE-build>
81
82
&folder=<absolute-path-to-a-project-folder>
82
83
```
83
84
84
- | Query param | Description | Mandatory |
85
- | ------------------| --------------------------------------------------------------------------------| -----------|
86
- | url | Your Coder deployment URL (encoded) | Yes |
87
- | token | Coder authentication token | Yes |
88
- | workspace | Name of the Coder workspace to connect to. Agent name should not be included. | Yes |
89
- | ide_product_code | JetBrains IDE product code (e.g., GO for GoLand, RR for Rider) | No |
90
- | ide_build_number | Specific build number of the JetBrains IDE to install on the workspace | No |
91
- | folder | Absolute path to the project folder to open in the remote IDE (URL-encoded) | No |
85
+ | Query param | Description | Mandatory |
86
+ | ------------------| ------------------------------------------------------------------------------| -----------|
87
+ | url | Your Coder deployment URL (encoded) | Yes |
88
+ | token | Coder authentication token | Yes |
89
+ | workspace | Name of the Coder workspace to connect to. | Yes |
90
+ | agent | Name of the agent associated with the workspace | No |
91
+ | agent_id | ID of the agent associated with the workspace | No |
92
+ | ide_product_code | JetBrains IDE product code (e.g., GO for GoLand, RR for Rider) | No |
93
+ | ide_build_number | Specific build number of the JetBrains IDE to install on the workspace | No |
94
+ | folder | Absolute path to the project folder to open in the remote IDE (URL-encoded) | No |
95
+
96
+ If only a single agent is available, specifying an agent name or ID is optional. However, if multiple agents exist,
97
+ you must provide either the name or ID to target a specific one. Note that this version of the Coder Toolbox plugin
98
+ does not automatically start agents if they are offline, so please ensure the selected agent is running before
99
+ proceeding.
92
100
93
101
If ` ide_product_code ` and ` ide_build_number ` is missing, Toolbox will only open and highlight the workspace environment
94
- page.
95
- Coder Toolbox will attempt to start the workspace if it’s not already running; however, for the most reliable
102
+ page. Coder Toolbox will attempt to start the workspace if it’s not already running; however, for the most reliable
96
103
experience, it’s recommended to ensure the workspace is running prior to initiating the connection.
97
104
98
- If the agent is down, or we can't resolve an agent for the workspace.
99
-
100
105
## Releasing
101
106
102
107
1 . Check that the changelog lists all the important changes.
103
108
2 . Update the gradle.properties version.
104
109
3 . Publish the resulting draft release after validating it.
105
- 4 . Merge the resulting changelog PR.
106
-
107
- ## ` main ` vs ` eap ` branch
110
+ 4 . Merge the resulting changelog PR.
0 commit comments