Installation

View as Markdown

Installing the Extension

1. Open VS Code.
2. Go to the Extensions view (Ctrl+Shift+X / Cmd+Shift+X).
3. Search for RocketRide.
4. Click Install.

First-Run Setup

On first launch, the extension shows a Welcome page to guide you through setup:

1. Choose a connection mode: Cloud, on-premises, or local.
2. Enter your server URL: For on-premises or local mode (default: http://localhost:5565).
3. Enter your API key: Your RocketRide authentication token. This is stored securely in VS Code's secret storage.
4. Click Connect: The extension tests the connection and shows status in the status bar.

After initial setup, the extension auto-connects on startup.

Configuration Settings

Open VS Code settings (Ctrl+, / Cmd+,) and search for rocketride to configure:

Connection

Setting	Default	Description
rocketride.connectionMode	-	Connection mode: cloud, onprem, or local
rocketride.hostUrl	http://localhost:5565	RocketRide server URL
rocketride.deployment.hostUrl	https://cloud.rocketride.ai	Cloud deployment API URL

Credentials are not a settings key. Enter your API key with the Settings page command rocketride.page.settings.setupCredentials (update or clear it via rocketride.page.settings.updateApiKey / rocketride.page.settings.clearApiKey). It is held in VS Code SecretStorage, not in settings.json.

Pipeline

Setting	Default	Description
rocketride.defaultPipelinePath	-	Default directory for new pipeline files
rocketride.pipelineRestartBehavior	-	Restart behavior: auto, manual, or prompt

Local Engine

Setting	Default	Description
rocketride.local.engineVersion	latest	Engine version: latest, prerelease, or a specific tag
rocketride.engineArgs	-	Additional startup arguments for the local engine

Integrations

Setting	Default	Description
rocketride.integrations.copilot	-	Enable GitHub Copilot integration for pipeline development
rocketride.integrations.cursor	-	Enable Cursor IDE integration