mirror of https://github.com/DioxusLabs/dioxus synced 2024-11-30 08:00:21 +00:00

History

Andrew Voynov c22014571e refactor(cli): added multiple nested errors support Before the top-level error message would print the dependent error message. Now multiple nested errors can be shown (with anyhow context).		2024-01-30 18:09:21 +03:00
..
.vscode	Prepare CLI for move into mainline	2023-06-28 17:21:23 -07:00
src	refactor(cli): added multiple nested errors support	2024-01-30 18:09:21 +03:00
tests	fix(cli): allows extracting files without separate directory entries	2023-08-04 21:28:09 -07:00
.gitignore	Prepare CLI for move into mainline	2023-06-28 17:21:23 -07:00
build.rs	using cargo.toml version (#1813 )	2024-01-11 13:50:23 -06:00
Cargo.toml	Merge branch 'master' into master	2024-01-28 11:57:38 -08:00
Dioxus.toml	Improve CLI docs (#1404 )	2023-09-02 17:59:20 -05:00
README.md	fix: no project-name in argument of `dx create` (#1803 )	2024-01-09 13:22:38 -06:00

README.md

📦✨ 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

cargo install --path . --debug

Get started

Use dx create to initialize a new Dioxus project. It will be cloned from the dioxus-template repository.

Alternatively, you can specify the template path:

dx create --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.