Shell Integration
Learn to open external links, files, and directories using the operating system's default applications via Electron's `shell` module.
Shell Integration is a free Electron Desktop App Development lesson on CoddyKit — lesson 3 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Electron Desktop App Development learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
Intro to Shell Integration
Welcome to Shell Integration! In Electron, your desktop app can interact with the user's operating system (OS) in powerful ways.
This means opening external links, files, or even showing items in the OS file explorer, just like native apps do.
Meet the `shell` Module
Electron provides the built-in shell module to make these OS interactions easy and safe. It's available in both the main and renderer processes.
The shell module lets your app delegate tasks like opening URLs or files to the OS's default applications.
Opening External URLs
The most common use case is opening web links in the user's default browser. You can do this with shell.openExternal(url).
This is crucial for security: instead of rendering external web content inside your app, you hand it off to a trusted browser.
Code: Open an External Link
Here's how you can open an external URL. This code would typically be in your main.js or called from a preload script if triggered by the renderer.
Try running this example:
const { app, shell } = require('electron');
app.whenReady().then(() => {
// In a real app, this would be triggered by a user action.
// For this demo, it opens when the app is ready.
shell.openExternal('https://www.electronjs.org/docs')
.then(() => console.log('Opened Electron docs!'))
.catch(err => console.error('Failed to open URL:', err));
// A real Electron app would also create a BrowserWindow here.
});Opening Local Files & Folders
Need to open a document, image, or even a directory from your app? Use shell.openPath(path).
This function attempts to open the given file or directory with the OS's default application for that file type.
Code: Open a Local File
This example creates a simple text file and then opens it using the OS's default text editor.
Try running this example:
const { app, shell } = require('electron');
const path = require('path');
const fs = require('fs');
app.whenReady().then(() => {
const userDataPath = app.getPath('userData');
const filePath = path.join(userDataPath, 'my-document.txt');
// Create a dummy file for demonstration
fs.writeFileSync(filePath, 'Hello from CoddyKit! This is your document.');
shell.openPath(filePath)
.then(() => console.log(`Opened: ${filePath}`))
.catch(err => console.error(`Failed to open path: ${err}`));
});Showing Items in Explorer/Finder
Sometimes you don't want to open a file, but just show where it is. shell.showItemInFolder(fullPath) does just that.
It reveals the specified file in the user's operating system file manager (e.g., File Explorer on Windows, Finder on macOS), and optionally selects it.
Code: Show Item in Folder
Let's create another file and then show its location to the user.
Try running this example:
const { app, shell } = require('electron');
const path = require('path');
const fs = require('fs');
app.whenReady().then(() => {
const desktopPath = app.getPath('desktop');
const fileToShowPath = path.join(desktopPath, 'coddykit_demo_file.txt');
// Create a dummy file on the desktop
fs.writeFileSync(fileToShowPath, 'Find me!');
shell.showItemInFolder(fileToShowPath);
console.log(`Showing item in folder: ${fileToShowPath}`);
});Security & Best Practices
When using shell methods, especially with user-provided input, always consider security:
- Validate URLs: Before calling
openExternal(), ensure the URL is safe and intended. - Context Isolation: In the renderer process, use a preload script to expose only necessary
shellfunctions securely. - Error Handling: Always include
.catch()for promise-based methods likeopenExternalandopenPath.
Quick Check on Shell
Which shell module method would you use to open a web link in the user's default browser?
Recap: Shell Integration
Great job! You've learned how Electron's shell module helps your app interact with the native OS:
shell.openExternal()for web links.shell.openPath()for local files/folders.shell.showItemInFolder()to reveal items in the file manager.
These methods provide a seamless and secure way to extend your app's functionality to the native environment.
Frequently asked questions
Is the “Shell Integration” lesson free?
Yes — the full text of “Shell Integration” is free to read here on the web, and the Electron Desktop App Development course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Electron Desktop App Development course, upgrade to CoddyKit PRO.
What will I learn in “Shell Integration”?
Learn to open external links, files, and directories using the operating system's default applications via Electron's `shell` module. You practise Electron Desktop App Development with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start Electron Desktop App Development?
No prior experience is required. Electron Desktop App Development on CoddyKit is structured for beginners through advanced learners; this is — lesson 3 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “Shell Integration” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this Electron Desktop App Development lesson?
Yes. Every Electron Desktop App Development lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.