Home > Tools for the Nuxeo Platform > Nuxeo Dev Tools Extension
Tools for the Nuxeo Platform

Nuxeo Dev Tools Extension

Updated: November 15, 2024

The Nuxeo Dev Tools browser extension puts some of the more commonly performed actions in the Nuxeo Platform at the administrator's fingertips in a popup window in Google Chrome or Mozilla Firefox.

Nuxeo Dev Tools extension
Nuxeo Dev Tools extension

Watch the related courses on Hyland University

Installation

Requirements

  • The Nuxeo Dev Tools extension requires Nuxeo Platform 8.2 and above.
  • If using an LTS distribution, all available hotfixes should be installed.

Installation

You can install directly from the Chrome Web Store or Mozilla Addons.

Building from GitHub

Alternatively you can build from our GitHub repository:

$ git clone [email protected]:nuxeo/nuxeo-browser-extension.git
$ cd nuxeo-browser-extension
$ npm install
$ gulp clean build

Features

Features include:

  • Hot Reload of your registered Nuxeo Studio project
  • Designer Live Preview of Web UI customizations
  • Restart server
  • Rebuild Elasticsearch Index
  • Connect to API Playground
  • Automation Call Tracing toggle
  • Useful Links menu
  • Document Search with JSON export (search with path, GUID or file name)
    Searching documents from the Nuxeo Dev Tools extension
    Searching documents from the Nuxeo Dev Tools extension
  • One-click JSON export of document in current active tab
    JSON Export of a document using the Nuxeo Dev Tools extension
    JSON Export of a document using the Nuxeo Dev Tools extension
  • Chrome Omnibox to search for documents without even opening the extension
  • Link to our Customer Feedback Portal from the About page. You can vote for requested features or even suggest your own, anonymously if you wish.

Hot Reload

Hot reloading updates your instance with all your Nuxeo Studio customizations.

  1. Install the extension (see Installation or Building from GitHub).
  2. Make sure Dev mode is enabled by checking your nuxeo.conf file (org.nuxeo.dev=true should be enabled).
  3. Start your Nuxeo instance.
  4. Modify your Studio Project.
  5. Go to your running server.
  6. In the extension bar, open the Nuxeo Dev Tools extension.
  7. In the pop-up window, click on Hot Reload. When the browser refreshes, the instance will be updated with your modifications.

Designer Live Preview

Preview your Web UI customizations without having to wait for a hot reload.

  1. Open your browser and navigate to your Nuxeo instance.
  2. In a separate tab, log into Studio.
  3. From the browser extension, activate the Designer Live Preview toggle.
  4. Customize the Web UI from Studio Designer and save your changes.
  5. Refresh your browser and see your customizations in the Web UI!

Chrome Omnibox

  • In the Chrome URL field, enter nx then hit tab. This will activate the Nuxeo Dev Tools omnibox.
  • Enter the correct path or GUID of an existing document and the document JSON will open in a separate tab.
  • Entering plain text will perform a full-text search, or you can enter an NXQL query.
  • Searches return the first 5 results in a dropdown window from the omnibox.
    Chrome Omnibox search
    Chrome Omnibox search

Limitations

  • Multiple Studio projects are not supported.
  • The extension is only active when a Nuxeo instance is in the current active tab.
  • The Hot Reload and Designer Live Preview buttons are only active when a Studio project is associated with the current Nuxeo server.
  • You must have Administrator access for some features.
  • Dev Mode must be activated to benefit from the Hot Reload feature.
  • CORS config must be activated in your Nuxeo server to connect to your repository on API Playground.
  • Some features may not behave correctly in Incognito/Private mode.
  • Designer Live Preview with HTML imports is currently unavailable in Chrome.