dioxus/packages/cli
Marc Espín c8c4e85e65
feat: Remove unused deps (#1447)
* feat: Reduce dioxus-cli deps

* remove more unused deps
2023-10-09 10:14:46 -05:00
..
.github/workflows Update all uncommented commands to remove actions-rs (#1366) 2023-08-22 19:48:03 -05:00
.vscode Prepare CLI for move into mainline 2023-06-28 17:21:23 -07:00
docs fix: Add the --locked param to every cli installation command (#1427) 2023-09-04 07:28:38 -05:00
examples Prepare CLI for move into mainline 2023-06-28 17:21:23 -07:00
src feat: Remove unused deps (#1447) 2023-10-09 10:14:46 -05: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 Prepare CLI for move into mainline 2023-06-28 17:21:23 -07:00
Cargo.toml feat: Remove unused deps (#1447) 2023-10-09 10:14:46 -05:00
Dioxus.toml Improve CLI docs (#1404) 2023-09-02 17:59:20 -05:00
README.md fix: Add the --locked param to every cli installation command (#1427) 2023-09-04 07:28:38 -05:00

📦 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 all building, bundling, development and publishing to simplify development.

Installation

cargo install dioxus-cli --locked

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 project-name to initialize a new Dioxus project. It will be cloned from the dioxus-template repository.

Alternatively, you can specify the template path:

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