Extension Registry Help

Help for using the Brackets Extension Registry

Writing an extension

See How to Write Extensions.

Publishing your extension in the Registry

First, make sure you have your extension in the extension package format which is basically a .zip file with a package.json file in it. If your extension is on GitHub, you'll find a link to a zip file in the navigation elements on the right-hand side of your repository.

1. Go to the Registry site
2. Log in with your GitHub credentials. We never see your GitHub password and your extension itself doesn't need to be on GitHub (see below).
3. Drag and drop your zip file onto the big upload square, or click the square to browse to your zip file

Updating your extension

Increase the version number in your package.json and then follow the exact same steps above to upload it again. The Registry will detect that you're updating an existing extension. (If you forget to increase the version number, the Registry will refuse the upload).

Note: If the latest version of your extension isn't compatible with a user's current Brackets version, the Extension Manager in Brackets will allow the user to download an older version of your extension. The user will see a message warning that they need to upgrade Brackets in order to install the latest version of the extension.

Do I have to have my code on GitHub?

No. Right now, the Registry requires a GitHub account in order to identify you to the registry. You can use any source repository and zip utility to create the extension package file that you upload.

Is the Registry open source?

Yes! It has its own repository on GitHub.

Removing an extension from the Registry

At present, there is no (automated) way to remove an extension from the registry. Contact the Brackets core team if you need to remove something completely from the listing.

As a quick workaround, you could upload an update to your extension that contains an empty main.js so that your extension basically does nothing (and change the package description to indicate it's obsolete).

I need some other help!

If you have questions that are not answered here, feel free to ask on the email list. If you have a security or other private issue, feel free to email brackets-registry (at aboutweb.com – the company that is hosting the Brackets Registry).