--- sourceDocument: Australia Build or modify applications sourceDocumentLink: https://www.servicenow.com/docs/r/australia/application-development Release : - australia ft:locale : - en-US ft:publication_title : - Australia Build or modify applications ft:clusterId : - cadev bundleId : - cadev workflow : - Development, Data, and Analytics --- # Lux Lab for VS Code # Lux Lab for VS Code {#ariaid-title1} Release version: Australia Updated September 29, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of Lux Lab for VS Code ServiceNow Lux Lab for VS Code integrates key application development workflows---project creation, instance browsing, local preview, build, and deployment---directly within Visual Studio Code. This extension complements the standalone Lux Lab desktop app, enabling users who prefer VS Code to maintain a consistent build, preview, and deploy experience inside their primary development environment. Show full answer Show less ## Requirements * Visual Studio Code version 1.97 or later * Node.js version 24 or later * pnpm version 10 or later * ServiceNow SDK version 4.14 or later * ServiceNow instance running Australia Patch 5 or later, or Zurich Patch 12 or later Use the **Lux : Show Environment Check** command to verify required versions of Node.js, pnpm, and ServiceNow SDK before creating projects. Any environment issues must be resolved to enable full functionality. ## Instance Connections Connect to ServiceNow instances through the Instance Explorer by either selecting **Connect to ServiceNow** or running **Lux : Add ServiceNow Instance**. Authentication supports: * **Basic Authentication:** Enter username, password, and profile alias. Credentials are validated and securely stored without being saved in project files. * **OAuth Authentication:** Use an authorization URL and code exchange with PKCE. No username or password entry needed in the extension. Note: Remote instances must use HTTPS for OAuth. ## Key Features * **Instance Explorer:** Browse Experiences, Pages, and Widgets on connected instances. Open metadata, source files, or preview artifacts. * **Script Runner:** Create projects, install dependencies, and run development commands including Dev, Build, Deploy, and Stop, with accessible command output and terminal views. * **Quick Preview:** Preview pages and widgets locally within VS Code. Save files and open previews via context menus or commands. * **Commands Palette:** Access extensive Lux commands such as creating projects and pages, managing instances, and running builds through VS Code's Command Palette. * **Context Menus:** Right-click or press-and-hold projects, pages, or widgets to access relevant actions and open terminals or file explorers directly. * **AI Agent Integration:** Supports AI-driven page and widget creation using the project's bundled skills, independent of a specific AI vendor. ## Workflow Use **Lux : Create Lux Project** to scaffold standalone ServiceNow applications by selecting the instance, folder, app name, template, and scope suffix. Vendor prefixes are retrieved and fixed from the instance, while suffixes remain editable. The extension automates scaffolding, dependency installation, and project opening. The **Lux : Create Page** command adds routes and initializes page scripts under the pages folder for standalone apps. For extension applications, follow the separate process documented in Create an extension application with Lux Lab. ## Practical Benefits for ServiceNow Customers * Streamlines ServiceNow application development within the widely used VS Code environment. * Enables seamless connection and browsing of ServiceNow instances to accelerate development and preview cycles. * Provides quick access to build, deploy, and preview commands without switching tools. * Enhances security by securely storing credentials and supporting modern OAuth flows. * Facilitates efficient project scaffolding and page creation with minimal manual setup. ServiceNow Lux Lab for VS Code brings project creation, instance browsing, local preview, build, and deployment into Visual Studio Code. It ships alongside the standalone Lux Lab desktop app as a separate product. Use the Lux Lab VS Code extension, rather than the standalone Lux Lab app, when you want the same build/preview/deploy workflow inside an editor you already use. The extension adds project creation, instance browsing, local preview, build, and deployment commands to VS Code. For the desktop app, see [Lux Lab](https://www.servicenow.com/docs/rNWHKcUWxrZnuu6bNivGfw "Lux Lab is the standalone desktop app for building Lux applications, not a VS Code extension. It combines a project explorer, code editor, instance browser, agent chat panel, source control, and build actions in one window."). ## Requirements {#lux-lab-for-vs-code__lux-lab-for-vs-code-requirements} {#lux-lab-for-vs-code__table_imf_rfb_dkc__entry__3} | Application | Version | Resources for more information | |-|-|-| | Visual Studio Code | 1.97 or later | [Visual Studio Code updates](https://code.visualstudio.com/updates/v1_132) | | Node.js | 24 or later | [Node.js](https://nodejs.org/en/download) | | pnpm | 10 or later | [pnpm](https://pnpm.io/installation) | | ServiceNow SDK | 4.14 or later | [ServiceNow SDK](https://www.npmjs.com/package/@servicenow/sdk) | | ServiceNow instance | * Australia Patch 5 or later * Zurich Patch 12 or later {#lux-lab-for-vs-code__ul_xtl_bgb_dkc} | [Prepare your upgrade](https://www.servicenow.com/docs/access?context=rn-prepare-landing-page&version=australia&pubname=australia-release-notes&ft:locale=en-US) | [ ] {#lux-lab-for-vs-code__table_imf_rfb_dkc} The Lux: Show Environment Check command displays the required and detected versions for Node.js, pnpm, and ServiceNow SDK. After fixing a failure, run Lux: Re-check Environment. Warning: The Environment Check page offers Skip checks and proceed anyway. Skipping leaves the extension's features enabled while the checks are unmet, and commands may fail. The check must pass before you can create a project. ## Instance connections {#lux-lab-for-vs-code__lux-lab-for-vs-code-instance-connections} You connect to an instance from Instance Explorer in the [Lux Lab](https://www.servicenow.com/docs/rNWHKcUWxrZnuu6bNivGfw "Lux Lab is the standalone desktop app for building Lux applications, not a VS Code extension. It combines a project explorer, code editor, instance browser, agent chat panel, source control, and build actions in one window.") activity bar view by selecting Connect to ServiceNow, or by running Lux: Add ServiceNow Instance. You enter the instance name or full URL, then select an authentication method. Basic : You enter your username, password, and a unique profile alias. The extension validates the credentials against the instance, then stores the profile in VS Code SecretStorage. The extension masks passwords and doesn't write them to the project. OAuth : You enter a profile alias, open the authorization URL the extension displays, authorize in the browser, and paste the returned code into a masked input. The extension exchanges it using Authorization Code with PKCE and stores the token in VS Code SecretStorage. You don't enter a username or password in the extension. : Remote instances must use HTTPS. ## What it provides {#lux-lab-for-vs-code__lux-lab-for-vs-code-what-it-provides} Instance Explorer : Browses Experiences, Pages, and Widgets on a connected instance. Select an artifact to open its metadata, open its source, or launch a preview. Script Runner : Creates projects, installs dependencies, and runs dev, build, and deploy. Actions include Dev, Build, Deploy, Stop, Show Command Output, and Show Dev Server Terminal. Quick Preview : Opens local preview-able pages and widgets without leaving VS Code. Save the file first, then select it in Quick Preview. You can also select and hold (or right-click) a preview-able file and select Lux: Open Preview. : An AI agent can drive page and widget creation through the project's bundled skills. The extension isn't tied to a specific agent vendor. ## Commands {#lux-lab-for-vs-code__lux-lab-for-vs-code-commands} Open the Command Palette (`Cmd+Shift+P` on macOS, `Ctrl+Shift+P` on Windows and Linux) and search for Lux`:`. * Lux`: Show Welcome Page` * Lux`: Show Environment Check` * Lux`: Re-check Environment` * Lux`: Add ServiceNow Instance` * Lux`: Sign in to Active Instance` * Lux`: Refresh Instance Explorer` * Lux`: Create LUX Project` * Lux`: Create Page` * Lux`: Run Script...` * Lux`: Build` * Lux`: Deploy` * Lux`: Open Preview` * Lux`: Show Command Output` Selecting and holding (or right-clicking) a project, page, widget, or preview-able file in the Explorer or [Lux Lab](https://www.servicenow.com/docs/rNWHKcUWxrZnuu6bNivGfw "Lux Lab is the standalone desktop app for building Lux applications, not a VS Code extension. It combines a project explorer, code editor, instance browser, agent chat panel, source control, and build actions in one window.") views gives the same actions in context. The context menu also opens a terminal and reveals a project in Finder or File Explorer. ## Workflow {#lux-lab-for-vs-code__lux-lab-for-vs-code-workflow} The Lux`: Create `Lux` Project` command scaffolds a standalone application. You select the instance, the parent folder, the application name, the project folder name, the Standalone App template, and the scope suffix. When the extension retrieves the vendor prefix from the instance, the prefix is fixed and only the suffix is editable. The extension then scaffolds, installs dependencies, and opens the project. The Lux`: Create Page` command adds a route and creates pages/\/page.js. For extension applications rather than standalone ones, see [Create an extension application with Lux Lab](https://www.servicenow.com/docs/e715jNwHg1jiQijDVosncA "Lux Lab's VS Code extension scaffolds, builds, and deploys an extension application through a guided UI. An extension application adds pages to an existing ServiceNow experience; it doesn't create a standalone experience."). **Related concepts** * [Lux Lab](https://www.servicenow.com/docs/rNWHKcUWxrZnuu6bNivGfw "Lux Lab is the standalone desktop app for building Lux applications, not a VS Code extension. It combines a project explorer, code editor, instance browser, agent chat panel, source control, and build actions in one window.") **Related reference** * [ServiceNow SDK](https://www.servicenow.com/docs/qqnlIBoD6w1T9XfXyLmSHg "ServiceNow SDK is the command-line tool that scaffolds, builds, and deploys a Lux application. It's distributed as the npm package @servicenow/sdk and invoked as now-sdk.")