CloudBackend for VS Code
Build XIOS/3 applications against the CloudBackend PaaS without leaving your editor.
Write your application manifests with full XML language support, keep the workspace and your cloud project in sync, and run the whole thing locally with live reload.
Features
Author XIOS/3 manifests with real language support
The XIOS/3 schemas ship inside the extension, so application, view and process documents get validation, completion and documentation as you type. No sign-in required — this half of the extension never touches the network.
- Validation against the bundled schemas. Only XIOS/3 manifests are checked — documents not rooted at
application, view or process are left alone, so your data XML is not reported as broken for simply existing.
- Completion and hover documentation taken from the published reference: 43 view components, all 27 process operations and 46 of their nested instructions carry a description and a working example, and all 76
trigger events carry a description. Around 100 instructions in total are offered in completion and on hover.
- Completion for the names in your own project: a
trigger's component, view and step, and the name/view of a <component> inside an operation, suggest what actually exists — narrowed to the relevant view, across a multi-file project, including unsaved edits.
- Go to definition (
F12, Ctrl+click) on those same names, on when/otherwise steps, on a call operation's target, and inside #view#component and $alias expressions. xlink:href and href open the linked document, so a multi-file manifest is navigable.
- Find all references (
Shift+F12) for component, view, step and alias names.
- Your own components and operations are understood. XIOS/3 is designed to be extended, and the extension reads your extensions back into the schema: a custom component tag declared in the application's
<components> block or in an index.html <script type="xios" name="addConfig"> validates and completes like a built-in one, and so does a custom operation declared in <operations> or registered through boot.addOperation(…) / boot.operations. An undeclared tag is still an error, so typos are still caught.

Keep your workspace and your cloud project in sync
Your project containers under home://Applications appear in the Projects view in the CloudBackend sidebar.
- Download a project: press the download arrow in the Projects view and choose where to put it. A folder named after the project is created there, and you choose whether to open it in this window or a new one.
- Upload the whole project (⬆️) or just the file you are looking at.
- Two-way sync (🔄) brings both sides to the same content in one step: what you changed is uploaded, what changed in the cloud is downloaded, and anything that changed in both places stops and asks you.
- Change detection is a three-way comparison against a baseline recorded at the last sync, so "changed here" and "changed there" are genuinely distinguishable.
- Conflicts resolve change by change. Merge writes both versions into the file as labelled blocks, so VS Code's own Accept Current / Accept Incoming / Accept Both actions appear above each one — only what actually differs asks for a decision. Discarding the merge restores the file untouched.
- Nothing is ever deleted. A file present on only one side is never removed from the other. Instead you are asked whether to put the missing copy back — handy when something was deleted in the cloud by mistake — and Leave it and stop asking settles it for good if it was meant to go.
- Binary files are compared byte-for-byte rather than decoded into a meaningless text diff.
- The full plan goes to a CloudBackend Sync output channel.
- Compare current file with cloud — the same diff on its own, from the editor or explorer right-click menu. It only ever opens a diff; it writes to neither side.
Uploads and syncs skip .git, .vscode, node_modules, xios, and whatever your .gitignore lists.

Run it locally, with live reload
Press ▶ in the editor title bar to serve the workspace and open it in your browser. Saving a file reloads connected tabs.

Pick a fixed port instead of a random free one:

Choose which XIOS/3 runtime version the local server boots — the extension rewrites index.html for you:

Before starting, ▶ checks the project's index.html and adds whatever it lacks to load the XIOS/3 runtime: the boot config, its runtime, startup and tenant values, and the boot.js script. Everything else is kept, and a message says what was added.
Still only a spinner in the browser? The XIOS/3 runtime (boot.js) didn't load, usually because the project's own index.html has config the repair can't fix. Stop the server, delete index.html and press ▶ again. You're asked which manifest to start and get a complete index.html. If you had added things to the old one, keep a copy and move them into the new file.
Start from a template
CloudBackend: Create from template… (also the ✚ button in the Projects view and on XML editor tabs) scaffolds a single-file manifest, a multi-file project (application + views/ + processes/ + layout/), a standalone view, process or custom JS component, or the live server's index.html.
Getting started
- Install the extension from the Marketplace. It installs XML by Red Hat alongside, which provides validation, completion and hover for manifests.
- Get an account. Join the early access programme at early.cloudbackend.cloud for a referral code and a free account.
- Open a folder. The extension works on an open workspace — most commands need one.
- Run
CloudBackend: Sign in from the Command Palette (Ctrl/Cmd+Shift+P), or click Sign in in the CloudBackend sidebar. You will be asked for your username, password and tenant, in a wizard you can step back through.

CloudBackend: Get started opens a walkthrough of the rest — getting a project, running it, syncing it — and CloudBackend: Open help opens the full reference. Once signed in, your account is in the status bar and in VS Code's Accounts menu; click the status bar item to open CloudBackend PaaS, switch account or tenant, or sign out.
Suggested workflow
Use source control — git or otherwise. The extension is designed not to fight it. Two things shape how the two fit together:
- git keeps the history; CloudBackend keeps the deployed copy. There is one copy per project container, so treat the cloud as whatever branch is currently checked out.
- The sync baseline lives in VS Code's per-workspace state, not in a file. Nothing to commit and nothing to add to
.gitignore — but nothing that survives a git clone, either.
- Sign in.
CloudBackend: Sign in, or Sign in in the CloudBackend sidebar. Authoring, the view/process/JS templates and the live server work signed out; the cloud project commands, and the templates filled in from your account, need the sign-in.
- Get the project onto disk through the extension, not through git, the first time. Press the download arrow on it in the Projects view and choose where to put it (a folder named after the project is created there) — or
Create project folder first, for something new. Downloading records the sync baseline and links the folder to the project; a folder that arrived any other way has no baseline, and then the first 🔄 reports every file that differs as "differs, and has never been synced" for you to answer by hand.
- Make it a git repo straight away.
git init && git add -A && git commit on the freshly downloaded state, before changing anything. That first commit marks "known equal to the cloud", and it is what you fall back on if a later sync writes something you did not want.
- Write a
.gitignore — it does double duty. Uploads and syncs skip .git, .vscode, node_modules, xios, and everything your .gitignore lists, so one file keeps build output, scratch data and local secrets out of both git and the cloud. Plain names count (dist, dist/, /dist); glob patterns like *.log are not interpreted.
- Scaffold and write.
Create from template… for a single-file manifest, a multi-file project, a standalone view, process or JS component, or the live server's index.html. Your own components and operations are read back into the schema, so custom tags validate too.
- Work on a branch.
git switch -c feature/x, and commit in small steps. The extension takes no part in this and gets in no one's way.
- Test locally before anything goes up. ▶ serves the workspace with live reload on save.
Select XIOS/3 version for live server rewrites index.html, so that is a tracked edit — commit it deliberately rather than letting it ride along with something else.
- Commit before you sync. Sync and download both write to your working tree. From a clean tree, undoing whatever the extension just did is
git restore .; from a dirty one, it is not.
- Push to the cloud only from the branch that should be live. Merge the feature branch first, then upload — otherwise you are deploying work in progress. ⬆️
Upload all project files to… when you are the only editor, Upload current file to… for a one-file fix.
- Use 🔄
Sync project with cloud (two-way) when the cloud side is edited too — by a colleague, or through CloudBackend PaaS directly. Your changes go up, theirs come down, and anything touched in both places stops and asks. The full plan is written to the CloudBackend Sync output channel; that is your record of what moved.
- Resolve conflicts, then commit before uploading. Merge writes the two versions as labelled blocks with VS Code's Accept Current / Accept Incoming / Accept Both above each one; discarding the merge restores the file untouched. Work through every block, check it with ▶, and commit. Leftover markers are caught before an upload, but a resolved-and-committed file is the state you actually want to deploy.
- Deleting takes a deliberate answer. A sync never deletes anything by itself: a file present on only one side asks whether to put the missing copy back. So a real deletion is — delete locally, commit, then choose Leave it and stop asking once, and it stays gone.
- After switching branches, sync on purpose rather than by reflex. git rewrites files behind the extension's back while the baseline still describes the last sync, so the branch's content reads as changed locally and will upload. Check out the branch you mean to deploy, then sync.
- To look without committing to anything, right-click a file → Compare current file with cloud. It only opens a diff; it writes to neither side. A good habit before a sync you are unsure about.
- Tag what you deploy. After a successful upload or sync,
git tag deploy-2026-08-10 or a version number. The cloud keeps no history, so the tag is your only route back to a known-good deployed state.
One project per workspace. The first command that needs a cloud project asks which one and links the workspace to it; after that sync, upload and compare use it without asking. The status bar shows the linked project and how many local changes are not in the cloud yet — click it to sync. Change the link with Link workspace to project…, or from a project's context menu in the Projects view.
One trap worth stating plainly: a colleague who clones from git has no baseline, so their first 🔄 flags every differing file as never-synced. Have them download the project through the Projects view once instead, or first sync at a moment when both sides are identical.
Commands
| Command |
What it does |
CloudBackend: Sign in / Sign out |
Sign in or out. Signing out forgets the stored credentials; sync history is kept. |
CloudBackend: Create from template… |
Scaffold XIOS/3 files. |
CloudBackend: Create project folder |
New project container under home://Applications. |
CloudBackend: Run project locally |
Start the live server and open the browser. |
CloudBackend: Stop live server |
Stop it again. Clicking the server in the status bar offers open in browser, copy URL and stop. |
CloudBackend: Select XIOS/3 version for live server |
Choose the runtime version index.html boots. |
CloudBackend: Upload all project files to… |
Upload the workspace to a project — only files that differ from the cloud copy are sent. |
CloudBackend: Upload current file to… |
Upload just the active file. |
CloudBackend: Sync project with cloud (two-way) |
Reconcile both sides, asking about conflicts. |
CloudBackend: Compare current file with cloud |
Diff the active file against its cloud copy. |
CloudBackend: Refresh projects |
Re-fetch the Projects tree. |
CloudBackend: Clear cached data |
Forget the cached folder lookups and re-fetch them. |
CloudBackend: Link workspace to project… / Unlink workspace from project |
Choose the project sync, upload and compare use without asking. |
CloudBackend: Get started |
Open the walkthrough. |
CloudBackend: Open settings |
This extension's settings (also the ⚙ in the CloudBackend views). |
CloudBackend: Open help |
Open the reference. |
CloudBackend: Open CloudBackend PaaS |
Open your tenant in the browser. |
Settings
The ⚙ button in the CloudBackend views opens these in the Settings editor.
| Setting |
Default |
What it does |
cloudbackend.xmlValidation |
true |
Validate application, view and process documents against the bundled XIOS/3 schemas, and offer completion in them. |
cloudbackend.suppressNoGrammarHint |
true |
Hide the "No grammar constraints" hint that XML by Red Hat shows on schema-less XML files. Real validation is unaffected. |
cloudbackend.completion |
true |
Offer this extension's completions in XML: operation names (built-in and the project's own) and element scaffolds. Schema completion is governed by xmlValidation. |
cloudbackend.autoScaffold |
true |
Insert the branches an operation such as a decision needs as soon as it is written without them. This edits the document while you type. |
cloudbackend.liveReload |
true |
Reload connected browsers when a file is saved. |
cloudbackend.defaultPort |
0 |
Port for the live server. 0 picks a free one — with 0 you need to refresh the tab once on first launch to pick up auto-reload. |
cloudbackend.xiosVersion |
latest |
Which XIOS/3 runtime version the live server boots: latest (the newest stable release on runtime.xios3.com) or a version such as xios_v2026.9.0. Changing it rewrites the boot config in your index.html. Select XIOS/3 version lists them all. |
Requirements
- VS Code 1.85 or newer.
- The XML by Red Hat extension, installed automatically alongside (extension pack). Without it, everything except manifest validation, completion and hover still works.
- A CloudBackend account. Manifest authoring — validation, completion, hover documentation, go to definition, find references — works signed out; the project, template and live-server commands are enabled once you sign in.
Links
| |