Build custom TurboWarp extensions with JavaScript modules (ESM).
- Built output looks almost identical to extensions that were not built with Twext.
- The CLI can also validate your extension, checking for inconsistencies or errors in your configuration.
- You can publish to a registry of extensions that were also created with Twext using the CLI. Read more about TwextHub.
Large JavaScript projects are usually multiple files. TurboWarp extensions should be the same, but they aren't.
Twext is a zero-config custom TurboWarp extension build tool meant to solve the problem that large extensions get harder to build the larger they are. With Twext, you can use ESM syntax to build an extension, instead of coding one in one file.
AI Disclosure: AI was used in the development of Twext.
-
Install Twext using
npm(from source):npm install
-
Scaffold your project:
node src/cli.js init
-
Build the scaffolded extension:
node src/cli.js # or twext build
To learn how to use Twext and build a functioning extension at the same time, see Build Your Extension.
To install Twext, you will need:
- A computer running Windows, MacOS, or a Linux distro.
- Node.js (recommended v24) installed with
npm.
Install with npm:
npm install @twextjs/twextDiscussions are turned off here, just open an issue if you have a question, or if you find a bug/a new feature to add.
If you want to contribute to this project, feel free! See the Development Guide.