Kurmi Platform Manager VS Code Extension

Kurmi Platform Manager integrates VS Code with Kurmi platforms so you can browse workspaces, edit files, and synchronize changes with a Git-like Source Control workflow.

Features

• Platform management: Add, open, and remove Kurmi platforms.
• Workspace navigation: Explore workspaces and files in dedicated views.
• Modes:
  • Live Edit: edit and auto-push on save.
  • Local Edit: work locally with pull/push.
  • Branch Compare: compare local vs remote vs builtin (origin).
  • Virtual Workspace: virtual FS, no local folder.
• SCM integration: Stage, commit, fetch, pull, push, diff (Kurmi vs Local, Origin vs Local).
• Deep links: Open platforms/workspaces via vscode:// links.

Getting Started

Prerequisites

• Visual Studio Code 1.60.0 or higher
• Access to a Kurmi platform (domain, login, password)

Add and Open a Platform

1. Open Command Palette (Ctrl+Shift+P) → Kurmi: Add Platform
2. Enter:
   • Platform domain (e.g., example.flow.com)
   • API path (default /Kurmi/restAPI.do)
   • Login and password (optionally cache in Secret Storage)
3. Open the Kurmi activity view and click your platform, or run Kurmi: Open Platform.
4. Choose mode and workspace when prompted.

Modes and Behavior

• Live Edit

  • Workspace root is virtual (kurmi:/<domain>/<workspace>).
  • On save, files auto-commit and Push is executed automatically.

• Local Edit

  • You choose a base sync folder (default base is c:\workspaces).
  • Files are checked out locally; use SCM actions: Fetch, Pull, Stage/Commit, Push.

• Branch Compare

  • Loads statuses comparing Local vs Remote vs Builtin (origin) and populates the “Changed Origin” group for diffs against builtin.

• Virtual Workspace

  • No local folder; uses virtual FS for browsing and remote content viewing.

Tree Views

• Kurmi Platforms (kurmiPlatformTree)

  • Shows configured platforms with version. Click to open (flow.openPlatform).

• Kurmi Workspace Files (kurmiWorkspaceTree)

  • Populated after selecting files. Categories reflect Kurmi design areas (e.g., Services, Quick features, etc.). Click to checkout/open or diff depending on the context.

Source Control

The extension creates a Kurmi SCM with groups:

• Remote Files
• Changed
• Staged
• Committed
• Changed Origin

Key actions: Fetch, Pull, Stage/Unstage, Commit, Push, Checkout File, Diff (Kurmi vs Local), Diff Builtin (Origin vs Local), Branch Compare.

Deep Links (vscode.UriHandler)

You can open a platform (and optionally preselect workspace/mode) via a link:

vscode://kyleflow.kurmi-platform-manager/openPlatform?platform=<domain>&workspace=<name>&action=<Live%20Edit|Local%20Edit|Branch%20Compare|Virtual%20Workspace>

Aliases: open, openPlatform, or empty path. Additional entries:

• Add platform: vscode://kyleflow.kurmi-platform-manager/addPlatform
• Remove platform: vscode://kyleflow.kurmi-platform-manager/removePlatform

Note: When provided, workspace and action are used to pre-seed state and streamline the init flow.

Commands

Platform commands:

• Kurmi: Add Platform (flow.addPlatform)
• Kurmi: Open Platform (flow.openPlatform)
• Kurmi: Remove Platform (flow.removePlatform)
• Kurmi: Reactivate Extension (flow.reactivateExtension)
• Kurmi: Save Untracked File (flow.saveUntrackedFile) – add a local file into a workspace

SCM commands (Kurmi Source Control):

• flow.sourceControl.commit
• flow.sourceControl.refresh
• flow.sourceControl.discard
• flow.sourceControl.pull
• flow.sourceControl.push
• flow.sourceControl.fetch
• flow.sourceControl.stageAll
• flow.sourceControl.unstageAll
• flow.sourceControl.checkoutFile
• flow.sourceControl.diff
• flow.sourceControl.diffBuiltin
• flow.sourceControl.branchCompare
• flow.sourceControl.openFile
• flow.sourceControl.upgradePrep

Utility commands:

• flow.updateWorkspaceFolder
• flow.dispose
• flow.diff

Troubleshooting

• Authentication failed: Verify credentials and platform permissions.
• Connection issues: Check network and platform URL.
• File sync problems: View → Output → select “Kurmi Platform Manager”.

Security Note

This extension sets NODE_TLS_REJECT_UNAUTHORIZED=0 to allow connections to platforms with self-signed certificates. In production environments, ensure proper TLS configuration on the platform.

Support

Contact: kyle.oneill@kurmi-software.com