A general purpose executable wrapper that can turn any application written in any programming language into an executable file.
Though there are numerous systems available today that attempts to solve the problem of converting applications usually written in scripting languages into executable apps that can easily be distributed (Electron, PyInstaller, etc.), they all usually have one or more of the following problems.
- Targeted at applications written in a particular programming language (E.g. Electron and PyInstaller).
- Not cross platform (You need to be on a similar machine to the target to be able to compile for such platforms).
- Have bloated configurations and/or require too many steps setting up and using.
ExWraptakes a different approach by allowing you to convert any application written in any language into an executable without changing any part of your code or altering how your code works or having to write with a set of fixed APIs.- By leveraging the power of Go,
ExWrapis cross-platform. This means you don't have to get a different machine to build for a new set of users. You can build for Windows from your MacBook. All (first-class) Golang compiler OS/Arch pairs are supported. ExWraptries its best to reduce configurations to the bearest minimum while maintaining the most familiar representation of objects you can have today (JSON) for its configuration meaning you usually don't have to learn anything different to start working withExWrap.- Despite this simplification,
ExWrapstill takes the do it yourself (DIY) approach to doing things. Meaning you get to decide what an executable is and what it contains.
- Generate Installers and Applications for:
- Windows
- Linux
- MacOS (Exe and .APP bundles)
- Support for major compiler architectures:
- i386
- AMD64
- ARM
- ARM64
- Cross-platform executable generation
- Pre-Install commands
- Post-Install commands
We do not have installation via package managers yet as ExWrap is still in the Pre-Alpha phase. You can download and built it yourself, or download a pre-built release.
To build it yourself, simply run the scripts/build.sh (for Linux and MacOS users) or scripts/build.cmd (for Windows user) file. Ensure you have go installed and available in user or system PATH.
NOTE:
You may also need to add
exwrapto PATH.
The documentation for this is in progress. However, you can check the examples folder for sample configurations.
For now, you can simply consult the impl/config.go file to see the available configurations.
The ONLY requirement for ExWrap is the existence of the exwrap.json file (or whatever name you choose). For simplicity, it might be preferred to always keep this files at the root of the application directory similar to how composer.json and package.json are being used today. However, the file can be anywhere on your system.
The only required configuration element is the entry_point. This is what specifies which command will be run when the application is launched.
Simply run the command exwrap from the directory containing the exwrap.json file.
Alternatively, you can run the following to point to another configuration file other than exwrap.json.:
exwrap -config /path/to/my-custom-exwrap-file.jsonBy default, ExWrap generates build into the build directory at the location from which the exwrap command was called. It will create this directory if it doesn't exist. The final executable can be found in that directory. However, it is possible to change the target directory by using the -dir flag.
exwrap -dir MyCustomBuildDirectoryYou can type exwrap --help for more.
Notice for all users
- When the installers are run, they'll automatically install the app into the configured install directory (or
C:\Program Files\<app name>and/home/$USERNAME/<app name>for Windows and Linux respectively if none is configured).- The name of the executable will be the name set in
target_nameor the name of the root directory iftarget_nameis not set.
Notice For MacOS users:
- While
ExWrapgenerates an installer Windows and Linux, for MacOS, it does not generate a DMG based installer but rather an executable installer. This is deliberate as there is currently no efficient cross-platform way to programmatically create DMG file on other operating systems without need for users to install extra 7133 dependencies which may of their own introduce new bottlenecks.- For this reason,
ExWraphas been enabled with the capability to generate an application (.app) file as an opt-in. To enable this, set the darwin > create_app config totrue.ExWrap is not a runtime ExWrap is not a runtime but an executable and installer generator. If any app makes system specific calls that are not available on other platforms, then it won't run on other platforms. However, ExWrap will still go ahead and generate a valid exe for other platforms. The app generated by ExWrap will definitely start on other platforms, but will crash since the code itself is making system specific calls. An app not running on other platforms is not a problem of ExWrap but a problem of the app itself. However, ExWrap will still do its own work (generating an exe) without you having to make any changes to your code.
All forms of contribution is welcomed and appreciated. Kindly open an issue feature requests, bugs, pull requests, and/or suggestions. Please star the project to help booster visibility and increase the community.