b257e7e8ce
* Add --renderer argument to the CLI Signed-off-by: Nico Burns <nico@nicoburns.com> * Make `--platform native` work Signed-off-by: Nico Burns <nico@nicoburns.com> * Emit `krates` error when cargo metadata fails * Reinstate default "desktop" feature for examples * Remove commented 'no platform specified' error Signed-off-by: Nico Burns <nico@nicoburns.com> * use the target tripple and bundle format as the source of truth for the build * resolve renderer and bundle format * add shorthand flags * add headings to the help for shorthands * resolve the renderer from the target triple if it isn't passed * make value after --fullstack optional * convert desktop -> mobile when targeting mobile webview * use the new shorthand flags in the playwright tests * fix clippy * merge fix * cleanup merge conflicts * fix clippy * remove nit * restore platform as a legacy argument * improve help message * vendor openssl on native, pin server_fn * print build errors as warnings * add --desktop arg compat * adjust cli headings * prefer self.is_wasm_or_wasi() --------- Signed-off-by: Nico Burns <nico@nicoburns.com> Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com> Co-authored-by: Evan Almloff <evanalmloff@gmail.com>
📦✨ Dioxus CLI
Tooling to supercharge Dioxus projects
The dioxus-cli (inspired by wasm-pack and webpack) is a tool for getting Dioxus projects up and running. It handles building, bundling, development and publishing to simplify development.
Installation
Install the stable version (recommended)
cargo install dioxus-cli
Install the latest development build through git
To get the latest bug fixes and features, you can install the development version from git. However, this is not fully tested. That means you're probably going to have more bugs despite having the latest bug fixes.
cargo install --git https://github.com/DioxusLabs/dioxus dioxus-cli
This will download the CLI from the master branch,
and install it in Cargo's global binary directory (~/.cargo/bin/ by default).
Install from local folder
Note: The CLI will fail to build projects in debug profile. This is currently under investigation.
cargo install --path .
Get started
Use dx new to initialize a new Dioxus project.
It will be cloned from the dioxus-template repository.
Alternatively, you can specify the template path:
dx new --template gh:dioxuslabs/dioxus-template
Run dx --help for a list of all the available commands.
Furthermore, you can run dx <command> --help to get help with a specific command.
Dioxus config file
You can use the Dioxus.toml file for further configuration.
Some fields are mandatory, but the CLI tool will tell you which ones are missing.
You can create a Dioxus.toml with all fields already set using dx config init project-name,
or you can use this bare-bones template (only mandatory fields) to get started:
[application]
name = "project-name"
# Currently supported platforms: web, desktop
default_platform = "web"
[web.app]
title = "Hello"
[web.resource.dev]