Skip to main content

Installation

Install the extension from the VS Code Marketplace:

ShardCloud for VS Code

Get the official ShardCloud extension from the Visual Studio Marketplace.
Or search for β€œShardCloud” in the VS Code Extensions panel (Ctrl+Shift+X / Cmd+Shift+X).

Cursor Users

For Cursor IDE, download the VSIX file directly and install it manually:

Download VSIX for Cursor

Download the .vsix file for manual installation in Cursor.
To install in Cursor:
  1. Download the VSIX file
  2. Open Cursor and go to the Extensions tab (Ctrl+Shift+X / Cmd+Shift+X)
  3. Drag and drop the downloaded .vsix file into the Extensions panel

Features

Application Management

Deploy, start, stop, and restart your applications with one click.

Database Management

View, manage, and connect to your databases from the sidebar.

Real-time Logs

Stream application logs directly in VS Code via SSE.

Resource Monitoring

Monitor RAM and CPU usage at a glance.

πŸš€ Application Management

  • Deploy your code to ShardCloud with one click
  • Start, Stop, Restart your applications
  • View Logs in real-time (SSE streaming)
  • Monitor Resources - RAM, CPU usage at a glance

πŸ’Ύ Database Management

  • View all databases in the sidebar
  • Start/Stop databases
  • Copy connection link for quick access
  • Copy database ID

πŸ“ .shardcloud Config Support

  • IntelliSense - Auto-completion for config keys
  • Validation - Real-time error checking
  • Hover docs - Documentation on hover
  • File auto-completion for MAIN= field

πŸ”— Quick Actions

  • Link existing apps to your workspace
  • Sync .shardcloud config from deployed apps
  • Open apps in ShardCloud Dashboard
  • Access websites directly

Getting Started

1

Login

Click the ShardCloud icon in the sidebar and enter your API token.
Get your token from ShardCloud Dashboard β†’ Config β†’ Integrations
2

Link an App

Click β€œLink to Existing App” in the Current App panel, or create a .shardcloud file manually.
3

Deploy

Right-click your app β†’ β€œDeploy to App”, or use the Deploy button in the Current App panel.

.shardcloud Config

Create a .shardcloud file in your project root:
# App configuration
APPID=your-app-id
NAME=my-app
MAIN=src/index.ts
RAM=512
VERSION=recommended
SUBDOMAIN=myapp
The extension provides IntelliSense and validation for this file.

Learn More

.shardignore

Control which files are excluded from deployment.

Commands & Settings

View all available commands and configuration options.

Troubleshooting

Ensure you’re logged in with a valid API token. Try logging out and back in. Check that your token has the correct permissions.
Check the Output panel (View β†’ Output β†’ ShardCloud) for error details. Verify your .shardcloud config is valid and APPID is set correctly.
Ensure your application is running. Check your network connection. Try restarting the log stream.
Reload VS Code window (Ctrl+Shift+P β†’ Developer: Reload Window). Ensure the extension is enabled.

Need Help?

Shard Cloud Community

Chat with developers, ask questions, and share feedback in our community Discord server.