Matt HunzingerandJonathan Kelley
0042430a36
* Add new crate to workspace members * Replace DioxusCrate with cargo metadata * Skip initializing git repo in already existing workspace * Fix init in workspace * Fix naming issues with new packages Changes how we parse names so `dx new packages/blah`creates a subdirectory instead --------- Co-authored-by: Jonathan Kelley <jkelleyrtp@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 .
Developing The CLI
It's faster to build the CLI using the cli-dev profile when testing changes.
cargo build --profile cli-dev
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.watcher]
[web.resource.dev]
The full anatomy of Dioxus.toml is shown on the Dioxus website.