Salesforce Assistant

Salesforce Assistant is a Visual Studio Code extension that helps developers run and explore SOQL queries directly within VS Code. It provides a simple query editor, tabular result view, export options, and metadata tools — all without leaving your Salesforce project.

✨ Features

• 📝 Run SOQL queries directly from VS Code.
• 📊 View query results in a clean, interactive table view (webview).
• 🔍 Export data easily to CSV or JSON.
• 📁 Explore objects/fields with the Object Explorer.
• 🧹 Clear cached metadata when needed
• 🔐 Automatically uses the currently authenticated Salesforce org (no extra setup).
• 🛠️ Configurable API version and cache TTL.

📸 Demo

🔧 Requirements

• 🛠️ Salesforce CLI must be installed.
• You must be logged into an org via:

  sf login web
  # or
  sfdx force:auth:web:login
  

• 💻 A Salesforce project open in VS Code.

🚀 Usage

1. 🎯 Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P).
2. Run one of the following commands:
   • SF Assistant: Run SOQL Query → execute a query and view results.
   • SF Assistant: Object Explorer → browse objects and fields.
   • SF Assistant: Clear Cache → clear cached metadata.
3. ✍️ Enter your SOQL query or browse metadata.
4. 👀 View results in the interactive table webview.
5. 📤 Use export buttons to download results as CSV or JSON.

Example query:

1. Simple query:

SELECT Id, Name, Type FROM Account WHERE CreatedDate = LAST_N_DAYS:30 LIMIT 10

2. Aggregate Query:

SELECT COUNT(Id), Type FROM Account GROUP BY Type LIMIT 10

3. Nested Query:

SELECT Id, Name, (SELECT Id, StageName FROM Opportunities)
FROM Account
WHERE CreatedDate = LAST_N_DAYS:30
LIMIT 10

⌨️ Keyboard Shortcuts (Keybindings)

You can configure your own shortcuts in VS Code under
File → Preferences → Keyboard Shortcuts (Ctrl+K Ctrl+S).

In SOQL Query editor window:

1. Ctrl + Enter to run query
2. Ctrl + Space to insert all shown suggestions

⚙️ Extension Settings

This extension contributes the following settings:

You can update these in VS Code settings.json:

{
  "sf-assistant.apiVersion": 61.0,
  "sf-assistant.cacheTTL": 1800000
}

🐞 Known Issues

• Only supports default org authentication.
• Very large result sets may cause performance issues in the table view.

🛣️ Roadmap

Planned enhancements for upcoming releases:

• ✅ Autocomplete for SOQL (objects, fields, operators, values).
• ✅ Context-aware suggestions (handle nested queries & sub-selects).
• 🔍 Improved Metadata Explorer: filter, search, and drill down.
• 🎨 UI improvements: better formatting, theming, and table controls.
• 🔄 Data Load: Create/Update/Delete records directly from the extension.
• ⚡ Performance optimizations for large datasets.
• 🧩 Custom Settings for query limits, formatting, and exports.

Suggestions and feedback are welcome to help shape future versions.

📝 Release Notes

0.0.1

• Initial release
• SOQL query execution
• Table result view
• Export to CSV/JSON
• Object Explorer
• Basic caching & settings

📚 References

• Salesforce CLI
• VS Code Extension Guidelines

💡 Tip: Keep your queries short and filtered to avoid hitting Salesforce limits or slowing down VS Code.

Enjoy using Salesforce Assistant! 🎉