Org Loom
Canvas Docs

Walkthrough

Install Org Loom in VS Code

Connect through Salesforce CLI and work with your records on a canvas. No managed package or Salesforce project is required.

1. Check the requirements

  • VS Code desktop 1.100.0 or later and a trusted workspace.
  • The current Salesforce CLI installed on the same computer.
  • A Salesforce org with API access. Your user needs API Enabled and View Setup and Configuration.
  • Read access to the objects, fields, and records you want to view. Uploads also need the relevant Create, Edit, or Delete permissions. A System Administrator profile is not required.

2. Install the extension and CLI

  1. Open Org Loom in the Visual Studio Marketplace and install the pre-release extension in VS Code.
  2. Install Salesforce CLI if you do not already have it.
  3. Fully close and reopen VS Code so it picks up the CLI installation. In a local terminal, run sf --version.

If you received a .vsix file, run Extensions: Install from VSIX… from the Command Palette and select that file.

3. Connect your Salesforce org

  1. Open the Command Palette with Ctrl+Shift+P on Windows or Cmd+Shift+P on macOS.
  2. Run Org Loom: Connect with Salesforce CLI.
  3. Select an authorized org, or choose Sign in to another org… and complete the CLI’s browser sign-in.
  4. Check the connected username. Production connections require an explicit confirmation.

You can authorize an org from any local terminal, without a Salesforce repository:

Sandbox

sf org login web --instance-url https://test.salesforce.com --alias orgloom-sandbox

Production or Developer Edition

sf org login web --instance-url https://login.salesforce.com --alias orgloom-org

If your org requires My Domain or SSO, replace the instance URL with its Salesforce My Domain login URL. Then run the Org Loom connect command again. Org Loom does not change your default CLI org.

4. Build your first canvas

Use Add records to browse or query Salesforce, then Find related to add connected records. Edit existing records or create drafts, review the changes, and select Upload to Salesforce when ready.

When you first open a connected canvas, choose Enable recovery to save encrypted recovery copies on this computer, or Not now to leave recovery off. You can change this later in VS Code Settings under Org Loom: Local Recovery: Enabled. Turning it off deletes saved recovery copies and keys without closing your current canvas.

Export CSV or JSON files to keep a copy of your work. Exported files are plaintext and need separate protection. The extension supports uploads of up to 500 submitted records.

Saving canvases in Salesforce, canvas sharing, field and record requests, and Upload Recall require the managed package. Compare the versions.

Reopen, disconnect, and troubleshoot

  • Org Loom: Open Salesforce Canvas reopens your remembered connection.
  • Org Loom: Disconnect Salesforce Org disconnects the extension. The CLI login remains authorized; use sf org logout --target-org <username-or-alias> to remove it separately.
  • CLI not found: check sf --version locally and fully restart VS Code.
  • Missing org: authorize it with the same local operating-system account used by VS Code.
  • Connection or permission error: ask your administrator to check API Enabled, View Setup and Configuration, and org authorization policies. Missing records or fields may also reflect object, field, or record access.

Read extension security and data handling or contact support@orgloom.com.