On this page
deno compile
, standalone executables
deno compile
allows you to create self-contained executables from a TypeScript
or JavaScript file.
This feature allows distribution of a Deno application to systems that do not
have Deno installed. Under the hood, deno compile
bundles a slimmed down
version of the Deno runtime along with your JavaScript or TypeScript code.
deno compile --allow-read --allow-net jsr:@std/http@1.0.0/file-server
deno compile --output ./game game.tsx
If you omit the --output
flag, the name of the executable file will be
inferred from the package or script name.
Flags Jump to heading
As with deno install
, the runtime flags used to
execute the script must be specified at compilation time. This includes
permission flags.
deno compile --allow-read --allow-net jsr:@std/http@1.0.0/file-server
Script arguments can be partially embedded.
deno compile --allow-read --allow-net jsr:@std/http@1.0.0/file-server -p 8080
./file_server --help
Cross Compilation Jump to heading
You can cross-compile binaries for other platforms by using the --target
flag.
# Cross compile for Apple Silicon
deno compile --target aarch64-apple-darwin main.ts
# Cross compile for Windows with an icon
deno compile --target x86_64-pc-windows-msvc --icon ./icon.ico main.ts
Supported Targets Jump to heading
Deno supports cross compiling to all targets regardless of the host platform.
OS | Architecture | Target |
---|---|---|
Windows | x86_64 | x86_64-pc-windows-msvc |
macOS | x86_64 | x86_64-apple-darwin |
macOS | ARM64 | aarch64-apple-darwin |
Linux | x86_64 | x86_64-unknown-linux-gnu |
Linux | ARM64 | aarch64-unknown-linux-gnu |
Icons Jump to heading
It is possible to add an icon to the executable by using the --icon
flag when
targeting Windows. The icon must be in the .ico
format.
deno compile --icon icon.ico main.ts
# Cross compilation with icon
deno compile --target x86_64-pc-windows-msvc --icon ./icon.ico main.ts
Dynamic Imports Jump to heading
By default, statically analyzable dynamic imports (imports that have the string
literal within the import("...")
call expression) will be included in the
output.
// calculator.ts and its dependencies will be included in the binary
const calculator = await import("./calculator.ts");
But non-statically analyzable dynamic imports won't:
const specifier = condition ? "./calc.ts" : "./better_calc.ts";
const calculator = await import(specifier);
To include non-statically analyzable dynamic imports, specify an
--include <path>
flag.
deno compile --include calc.ts --include better_calc.ts main.ts
Workers Jump to heading
Similarly to non-statically analyzable dynamic imports, code for workers is not included in the compiled executable by default. There are two ways to include workers:
- Use the
--include <path>
flag to include the worker code.
deno compile --include worker.ts main.ts
- Import worker module using a statically analyzable import.
// main.ts
import "./worker.ts";
deno compile main.ts
Code Signing Jump to heading
macOS Jump to heading
By default, on macOS, the compiled executable will be signed using an ad-hoc
signature which is the equivalent of running codesign -s -
:
$ deno compile -o main main.ts
$ codesign --verify -vv ./main
./main: valid on disk
./main: satisfies its Designated Requirement
You can specify a signing identity when code signing the executable just like you would do with any other macOS executable:
codesign -s "Developer ID Application: Your Name" ./main
Refer to the official documentation for more information on codesigning and notarization on macOS.
Windows Jump to heading
On Windows, the compiled executable can be signed using the SignTool.exe
utility.
$ deno compile -o main.exe main.ts
$ signtool sign /fd SHA256 main.exe