Plugin installation

Install plugin

In HBuilderX, click the menu [Tools] [Plugin Installation] to open the plugin installation window.

In addition to the core plugins shown in the figure below, please go to plugin market to download other plugins.

Installed plugins

The installed plugins of HBuilderX will be displayed in [Installed].

When a new version of the plugin is released, this plugin will display the word upgrade.

Install plugins from market

In Plugin Market, enter the plugin details page, click [Import Plugin], the installed HBuilderX will be called up.

Install plugin offline

nodejs plugin, if node_modules does not exist in the plugin, you have to manually run npm install.

windows

  1. Open Resource Manager and find the HBuilderX installation directory
  2. Open the 'plugins' directory of HBuilderX
  3. Copy/paste the downloaded HBuilderX plugins to the current directory. (Decompress the archive file if it is a ZIP package)
  4. Restart the HBuilderX editor

Mac

  1. Open the system terminal and run the following command to open the HBuilderX plugins directory (note: On MAC, The official version and the alpha version have different directories).
  2. Copy/paste the downloaded HBuilderX plugins to the current directory. (Decompress the archive file if it is a ZIP package)
  3. Restart the HBuilderX editor
# release
open /Applications/HBuilderX.app/Contents/HBuilderX/plugins/

# Alpha
open /Applications/HBuilderX-Alpha.app/Contents/HBuilderX/plugins/

FAQs on Plugins Install Failed

Recently, a part of our users have been getting problems with plugins install, e.g.

When failed on install plugins, click on the window menu 【Help - View Running Logs】 to find out the related errors, according them to get a deal.

Notes: All plugins were saved as zip packages on the server, it will download to the local directory update firstly, then it will automatically unpack to a folder named plugins which is at the same level with HBuilderX.exe if download succeed.

Q1: Network Issues

  • Maybe it is the network or the area was restricted, that caused it not able to connecting with the HBuilderX Updating Server。
  • Maybe it is not be able to connecting with the HBuilderX Updating Server by the computer's global network proxy is on.
  • Try to ping with ping update.liuyingyong.cn with your cli to check if the network connection is working.
  • Try to switch the network connecting method, maybe by 4G/5G hotspots on smartphone.

Q2: Move Failed

You might see the beneath logs written in your log history:

[info] try move "xxxxx" to "xxxx"
[info] move result: false

These are showing, copying to the target folder has been failed after the download has been done.

Solutions:

  • Try to uninstall and reinstall the plugin.
  • Windows OS: Close the HBuilderX then restart HBuilderX.exe with right mouse-click on 【Run as Administrator】.
  • Enter the folder which HBuilderX was installed in, then enter update/plugins, search for the zip pack of the plugin, unzip this package under the plugins dir which in the same directory as HBuilderX.exe.

03: Permission Problems of Local Directories

With appropriate permissions, your click will moving your unpacked HBuilderX plugins to the target directory automatically. But it may fail if without a suitable permission configuration when downloading or processing during the operation.

Q4: Unzip Failed

You might see the beneath logs written in your log history:

[info] Unpack plugin "xxxx"
[info] unzip "xxxx" failed

These are showing, unzipping has been failed after the download has been done.

Possible reasons:

  • No permission to unzipping to the target directory.
  • Encrypted package needs to decrypt before unzipping. As for some security reason, some companies are applying strategies, to encrypting on zip packages which includes executable files. The encrypted package needs to be decrypted firstly, then unzipped it to the plugins directory.

Q5: No More Storage on the Disk

The storage of the disk which HBuilderX was installed in was short. Make sure to check the disk first.

Q6: Failed on MD5 check

HBuilderX will check md5 signiture of downloaded zipped plugins. To resist some malicial modifies, it will install only if the consistent of the signitures has been assured.

If this happenes to you, please make sure you get in touch with offical staffs from HBuilderX.

Node-Plugin-Questions

Some node plugins, such as sass and less, were successfully installed, but HBuilderX prompts that the installation failed when the project is running.

Possible reason: node_modules installation failed. Enter the plugins directory of HBuilderX and manually execute command npm install --save.


Found mistake? Want to participate in editing? Edit this page on GitHub

HBuilderX plug-in development document, not translated into English, welcome to contribute. Translate this document on github