Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crabnebula-dev/cargo-packager
Rust executable packager, bundler and updater.
https://github.com/crabnebula-dev/cargo-packager
appbundle appimage bundle bundler deb debian dmg executable installer msi nsis packager rust wix
Last synced: 1 day ago
JSON representation
Rust executable packager, bundler and updater.
- Host: GitHub
- URL: https://github.com/crabnebula-dev/cargo-packager
- Owner: crabnebula-dev
- License: apache-2.0
- Created: 2023-09-06T00:03:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-02T15:27:49.000Z (about 1 month ago)
- Last Synced: 2024-09-02T15:51:30.544Z (about 1 month ago)
- Topics: appbundle, appimage, bundle, bundler, deb, debian, dmg, executable, installer, msi, nsis, packager, rust, wix
- Language: Rust
- Homepage: https://docs.crabnebula.dev/packager/
- Size: 3.86 MB
- Stars: 227
- Watchers: 4
- Forks: 14
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE.spdx
- Security: SECURITY.md
Awesome Lists containing this project
README
# cargo-packager
Executable packager, bundler and updater. A cli tool and library to generate installers or app bundles for your executables.
It also has a compatible updater through [cargo-packager-updater](./crates/updater/).
#### Supported packages:
- macOS
- DMG (.dmg)
- Bundle (.app)
- Linux
- Debian package (.deb)
- AppImage (.AppImage)
- Pacman (.tar.gz and PKGBUILD)
- Windows
- NSIS (.exe)
- MSI using WiX Toolset (.msi)
## Rust
### CLI
The packager is distributed on crates.io as a cargo subcommand, you can install it using cargo:
```sh
cargo install cargo-packager --locked
```
You then need to configure your app so the cli can recognize it. Configuration can be done in `Packager.toml` or `packager.json` in your project or modify Cargo.toml and include this snippet:
```toml
[package.metadata.packager]
before-packaging-command = "cargo build --release"
```
Once, you are done configuring your app, run:
```sh
cargo packager --release
```
### Configuration
By default, the packager reads its configuration from `Packager.toml` or `packager.json` if it exists, and from `package.metadata.packager` table in `Cargo.toml`.
You can also specify a custom configuration using the `-c/--config` cli argument.
For a full list of configuration options, see https://docs.rs/cargo-packager/latest/cargo_packager/config/struct.Config.html.
You could also use the [schema](./crates/packager/schema.json) file from GitHub to validate your configuration or have auto completions in your IDE.
### Building your application before packaging
By default, the packager doesn't build your application, so if your app requires a compilation step, the packager has an option to specify a shell command to be executed before packaing your app, `beforePackagingCommand`.
### Cargo profiles
By default, the packager looks for binaries built using the `debug` profile, if your `beforePackagingCommand` builds your app using `cargo build --release`, you will also need to
run the packager in release mode `cargo packager --release`, otherwise, if you have a custom cargo profile, you will need to specify it using `--profile` cli arg `cargo packager --profile custom-release-profile`.
### Library
This crate is also published to crates.io as a library that you can integrate into your tooling, just make sure to disable the default-feature flags.
```sh
cargo add cargo-packager --no-default-features
```
#### Feature flags
- **`cli`**: Enables the cli specifc features and dependencies. Enabled by default.
- **`tracing`**: Enables `tracing` crate integration.
## NPM (Node.js)
Checkout the packager NPM cli [README](./bindings/packager/nodejs/README.md)
## Examples
The [`examples`](./examples/) directory contains a number of varying examples, if you want to build them all run `cargo r -p cargo-packager -- --release` in the root of this repository. Just make sure to have the tooling for each example installed on your system. You can find what tooling they require by checking the README in each example. The README also contains a command to build this example alone if you wish.
Examples list (non-exhaustive):
- [`tauri`](./examples/tauri/)
- [`wry`](./examples/wry/)
- [`dioxus`](./examples/dioxus/)
- [`egui`](./examples/egui/)
- [`deno`](./examples/deno/)
- [`slint`](./examples/slint/)
- [`wails`](./examples/wails)
## Licenses
MIT or MIT/Apache 2.0 where applicable.