open
orc open opens the dashboard for the Workspace selected in the CLI in your default browser. Use it to inspect Workspace information and settings in the web app after working in the terminal.
CLI credentials and a selected Workspace are required. To link the current directory, run orc workspace link <workspace-id>. To set a default Workspace, run orc workspace use <workspace-id>. CLI credentials are not passed to the browser, so you may also need to sign in to the web app.
Usage
orc openOpen the selected Workspace dashboard in the default browser.
Check the target Workspace with orc workspace current.
How it works
orc open performs these steps:
- Selects the target in this order:
--workspace,ORCHESTOR_WORKSPACE_ID,.orchestor/workspace.jsonin the current directory, then the default Workspace in the active profile. - Checks the Workspace ID format and CLI credentials.
- Selects the web app address in this order:
ORCHESTOR_WEB_URL, the profile’swebUrl, thenhttps://orchestor.io, and builds the/w/<workspace-id>URL. - Starts the system default browser and outputs the Workspace ID, selection source, URL, and launch result.
The default URL is https://orchestor.io/w/<workspace-id>. The CLI builds the URL from local selection information. Sign-in to the web app and Workspace access checks take place in the browser. The launch result indicates that the browser launch was accepted; it does not verify that the page finished loading.
Examples
Open from a linked directory
Run the command in a directory linked to a Workspace. If --workspace and ORCHESTOR_WORKSPACE_ID are not set, the directory link is used.
orc openOpen from a linked directory
Opens the target Workspace dashboard in the default browser.
Specify a Workspace to open
orc open --workspace <workspace-id>Specify a Workspace to open
Inspect the URL without starting the browser
orc open --dry-run --jsonInspect the URL without starting the browser
Checks the Workspace and credentials, then displays the target URL as JSON. Does not start the browser.
Troubleshooting
No Workspace selected
If No Workspace selected. appears, change to the target directory and link the Workspace before opening it.
orc workspace link <workspace-id>
orc openLink a Workspace to the current directory and open its dashboard.
To use a default Workspace regardless of the directory, configure it as follows.
orc workspace use <workspace-id>
orc openSet the default Workspace and open its dashboard.
If the wrong Workspace opens, check the selection source with orc workspace current. --workspace and ORCHESTOR_WORKSPACE_ID take precedence over the directory link and default settings.
Missing credentials
If Not authenticated. appears, sign in with orc auth login. If the browser displays a sign-in page, also sign in to the web app.
Browser could not start
If Could not start the default browser. appears, manually open the URL in the error instructions or configure the system default browser.
Invalid Workspace ID or web app URL
Use letters, numbers, _, and - in Workspace IDs. Set the web app address to an HTTP or HTTPS URL without embedded credentials. Check ORCHESTOR_WEB_URL and webUrl in the active profile.
Global Options
The following global options can be used with orc open:
For details and examples, see global options.
orc workspace link— Link a Workspace to the current directory.orc workspace use— Set the default Workspace.orc workspace current— Check the selected Workspace and selection source.