Quick Start
Convert your first Salesforce string to a Custom Label in under 5 minutes. No API key required for the default setup.
Step 1 — Install
Section titled “Step 1 — Install”From the VS Code Extensions panel:
- Open VS Code
- Press
Cmd+Shift+X(Mac) orCtrl+Shift+X(Windows/Linux) to open Extensions - Search “Label Alchemy”
- Click Install
Or from the command line:
code --install-extension ramprasad94.labelalchemySee the full install guide for requirements and how to confirm activation.
Step 2 — Open a Salesforce project
Section titled “Step 2 — Open a Salesforce project”Open a folder containing a Salesforce DX project (one that has a sfdx-project.json or
force-app/ directory). Label Alchemy activates automatically when it detects Salesforce files.
Step 3 — Scan a file
Section titled “Step 3 — Scan a file”- Open any
.cls, LWC.js/.html, or Aura.cmp/.app/.jsfile - Press
Cmd+Shift+P(Mac) orCtrl+Shift+P(Windows) to open the Command Palette - Type “Label Alchemy: Scan Active File” and press Enter
Or: right-click the file in the Explorer and select “Label Alchemy: Scan Active File”.
Label Alchemy scans the file and opens the Proposed Changes panel listing every hard-coded string it found.
Step 4 — Review and approve
Section titled “Step 4 — Review and approve”In the Proposed Changes panel:
- Edit a label name — click any name to edit it. It’s validated live (40-char limit, valid characters, no duplicates). The Approve button stays disabled until all checked names are valid.
- Uncheck a label — if a string isn’t user-facing copy, uncheck it. It stays in your code untouched.
- View the diff — click View Diff next to any file to see the exact line changes in VS Code’s native diff editor.
- Approve All or Approve Selected — when you’re happy, click to apply.
Step 5 — Done
Section titled “Step 5 — Done”After approving:
- Your source file is updated — hard-coded strings replaced with the correct SF references
(
System.Label.Xfor Apex,{getter}for LWC HTML, etc.) CustomLabels.labels-meta.xmlis updated with the new label entries (you can set a category on labels in the review panel before approving)- For LWC HTML changes, the sibling
.jsis automatically updated with the import + getter - A change record is written to
labelalchemy-changes/— asummary.md,summary.csv, andpackage.xml— and an Open summary notification appears
Deploy to your org when ready:
sf project deploy start --source-dir force-app/main/default/labelssf project deploy start --source-dir force-app/main/default/classesOr use Deploy to Org from the Command Palette (a Paid feature — requires a license).
Scan a whole project (Audit Report)
Section titled “Scan a whole project (Audit Report)”To see every hard-coded string across your project:
- Right-click any folder in the Explorer → Label Alchemy: Scan Folder
Or press
Cmd+Shift+P→ Label Alchemy: Scan Folder → pick a folder - The Audit Report opens — total count, by component type, by file, with per-file drill-down, and an estimated manual-conversion time
- From the Audit Report, click Convert to Labels to apply bulk conversions [Paid]
The folder scan and Audit Report are free. Bulk convert requires a license.
Optional: Enable AI naming
Section titled “Optional: Enable AI naming”If you want richer label names from an LLM:
- Open the Command Palette → Label Alchemy: Configure Settings
- Choose AI-assisted naming
- Pick a provider (Anthropic, OpenAI, Gemini, DeepSeek, OpenRouter, Ollama, LM Studio, Custom)
- Pick a model, enter your API key (skipped for local providers)
- Label Alchemy runs a quick capability test — if it passes, you’re ready
Your API key is stored in VS Code’s encrypted secret storage. It’s never written to a settings file or logged.