esf - EasySFDX Terminal User Interface (TUI)

esf is a terminal-based development dashboard for Salesforce (SFDX) developers, designed to provide a highly interactive, fast, and feature-rich terminal user interface. It is migrated from the VS Code extension easysfdx .

Features & Tab Layout

1. [1] Deploy/Retrieve:

   • Lists all Git staged, unstaged, and untracked files.
   • Highlights file diffs with syntax coloring (green for additions, red for deletions).
   • Press Space to toggle selection of files.
   • Press d to deploy selected files to your target Salesforce org.
   • Press D to deploy selected files with a Dry Run verification.
   • Press r to retrieve selected files from Salesforce.
   • Press m to show a list of metadata types and retrieve selected types.
   • Press a to retrieve all metadata.
   • Press g to refresh Git status.

2. [2] SOQL Browser:

   • Focus the query box, type any SOQL query (e.g., SELECT Id, Name FROM Account LIMIT 10), and press Ctrl-e to execute.
   • View query results formatted as colored JSON records.

3. [3] Apex Logs:

   • Lists recent Salesforce Apex Logs.
   • Select a log from the list to display its complete body in the detail viewer with custom warning/debug syntax highlighting.
   • Press g to refresh the log list.
   • Press t to open a real-time log tail stream (sf apex log tail).

4. [4] Apex Jobs:

   • Lists and monitors Salesforce AsyncApexJob records (Batch Apex, Queueable Apex, etc.) with real-time status colors and execution progress.
   • Press Enter on any job to view an overlay dialog showing complete details (including stack traces/error messages if failed).
   • Press g to refresh the job list.

5. [5] Metadata Explorer:

   • Browse metadata components (e.g., ApexClass, ApexTrigger) directly from Salesforce.
   • View the source code body of classes and triggers directly in the TUI.
   • Press g to refresh the list of items.

6. [6] Org Manager:

   • Displays all authenticated Salesforce orgs (sf org list).
   • Press Enter on any org in the list to switch your default Salesforce target org (sf config set target-org=<alias>).
   • Displays detailed credentials, login URLs, and access tokens for the highlighted org.
   • Press g to refresh the org list.

7. [7] CSV Viewer:

   • Scans your current workspace root folder for .csv files.
   • Select any CSV file to display its contents in a beautifully formatted text grid with auto-aligned column borders.

Prerequisites

• Node.js (v18 or higher)
• Salesforce CLI (sf) installed and authenticated to your org(s).
• Git (optional, required for Tab 1 Deploy/Retrieve changed files).

Installation & Running

Initialize the project dependencies:

npm install

Dev Mode

Run the tool directly from TypeScript source:

npm run dev

Production Build & Run

Compile the TypeScript code using tsup:

npm run build

Start the compiled CommonJS bundle:

npm start

Global Navigation Keys

• 1 to 7: Switch tabs.
• Tab: Cycle focus between panels (e.g., from list to diff box).
• Ctrl-c: Exit the application.
• Up / Down (or j / k): Scroll lists or text views.