Manage your Square Cloud applications, databases and workspaces without leaving the editor.
- Install Square Cloud from the VS Marketplace or Open VSX.
- Grab your API key from the Square Cloud dashboard.
- Open the Square Cloud activity bar icon → click Set API key (or run
Square Cloud: Set new API keyfrom the command palette).
Your key is stored in the OS keychain via VSCode's SecretStorage — never written to disk in plaintext. If you used a previous version with the legacy auth.json file, it's migrated automatically on first run.
- Lifecycle — start, stop, restart with a single click. Status auto-refreshes after each action.
- Commit — push files or a whole folder to an existing app. Respects
squarecloud.ignoreand offers to use.gitignoreas a fallback. - Upload — create a brand new application from a local folder. Validates
squarecloud.app/squarecloud.configclient-side before zipping. - Snapshots — download the latest snapshot, or restore the app to any previous one.
- Environment variables — list, add, edit, delete or wipe all env vars through a QuickPick.
- 24h metrics — CPU/RAM/network time series rendered into an output channel (288 samples, every 5 min).
- Realtime stream — Server-Sent Events from the app surfaced into a dedicated output channel. Toggle with one command.
- GitHub App integration — link or unlink a repository for automatic deploys.
- Logs — fetch the latest app logs with ANSI colour preserved.
- Edge analytics (website applications) — inspect errors, edge logs, performance breakdowns, or purge the edge cache.
Create, start, stop and delete managed databases (MongoDB, MySQL, Redis, Postgres). Download the TLS bundle as .pem + .crt + .key (private keys are split out only when present).
Create workspaces, generate invite codes, leave or delete them. View members and shared applications inline.
squarecloud.app and squarecloud.config files get full editor support — no JSON schema or external language server required.
Inline diagnostics
- Missing required keys (
MAIN,VERSION,MEMORY,DISPLAY_NAME) underlined as errors. - Duplicate keys flagged on the second occurrence.
- Value bounds:
DISPLAY_NAME ≤ 32,DESCRIPTION ≤ 280,START ≤ 256,SUBDOMAIN ≤ 63characters. MAINresolves the referenced file against the workspace and warns if it doesn't exist, is outside the project, or sits insidenode_modules/__pycache__/ dotfiles.MEMORYvalidates against the official minimum (256 MB bot / 512 MB site) and your plan's available memory — the diagnostic ships with an "Upgrade plan" link when you exceed your quota.SUBDOMAINrejects characters outside[a-zA-Z0-9-].RUNTIMEvalidates against the 15 accepted aliases from the docs (nodejs,javascript,typescript,python,dotnet,csharp,c#,java,elixir,rust,php,go,golang,static,html).VERSIONacceptsrecommendedorlatest.MAINbecomes optional automatically whenSTARTis set, matching the docs.
Auto-completion
- Key suggestions on empty lines — required fields are pinned to the top.
- Triggered on
=:MAIN=lists every file in the workspace that matches a runtime-aware extension allowlist.RUNTIME=shows all valid runtime aliases.VERSION=showsrecommended/latest.AUTORESTART=showstrue/false.MEMORY=shows tier-aware presets (256 MB, 512 MB, 1 GB, 2 GB, …) and automatically hides values under 512 MB onceSUBDOMAINis declared.
Quick-fixes
Lightbulb actions on diagnostics for AUTORESTART, VERSION and RUNTIME insert a valid value with one click.
Syntax highlighting & file icons
Custom file icons for squarecloud.app, squarecloud.config and squarecloud.ignore, plus a small TextMate grammar for keyword/value coloring.
A status bar item shows at a glance whether the API key is set, how many apps are online vs total, and whether Square Cloud's service is degraded. Click it to refresh.
Available in English, Português (Brasil) and Español. VSCode picks the active locale automatically.
| Command | Where |
|---|---|
Square Cloud: Set new API key |
Command palette |
Square Cloud: Upload new application |
Apps view title bar, command palette |
Square Cloud: Show service status |
Apps/User view title bar, command palette |
Square Cloud: Create workspace |
Workspaces view title bar, command palette |
Square Cloud: Generate workspace invite code |
Workspaces view title bar |
Square Cloud: Create database |
Databases view title bar, command palette |
| Start, Stop, Restart, Logs, Commit, Snapshot, Restore snapshot, Metrics, Realtime, Env vars, Link/Unlink GitHub App, Edge errors/logs/performance, Purge cache, Copy ID, Delete | Right-click an app in the Applications view |
| Start, Stop, Delete, Download TLS certificate | Right-click a database |
| Leave, Delete | Right-click a workspace |
| Setting | Default | Description |
|---|---|---|
squarecloud.favApps |
[] |
List of favourited application IDs. Managed by the favourite/unfavourite tree-item actions — usually you don't edit this by hand. |
The extension activates lazily when one of the following is true:
- A
squarecloud.apporsquarecloud.configfile exists in the workspace. - You open one of the Square Cloud tree views, run a Square Cloud command, or edit a Square Cloud config file.
No background activity until then — startup overhead for unrelated VSCode windows is zero.
- VSCode 1.120 or newer.
- An active Square Cloud account with an API key.
- Some commands (databases, workspaces, edge analytics, GitHub App linkage) require a paid plan — the extension shows a clear error if your plan doesn't allow the action.
- Logs — open
View → Outputand pickSquare Cloudto see structured logs (info/warn/error). Useful when reporting bugs. - API errors — friendly toasts map common SDK codes (
INVALID_API_TOKEN,RATE_LIMIT_EXCEEDED,APP_NOT_FOUND, …). Less common codes fall back to a generic message; the raw code is always in the output channel. - Stale state — click the status bar item or run
Square Cloud: Refreshto force a refresh. Polling pauses when the editor is unfocused and resumes when it gets focus back.
Issues, suggestions and PRs are welcome at the GitHub repository. See CONTRIBUTING.md for setup, lint and build instructions.
MIT — see LICENSE.