Benjamin Manns
972235bd6f
The README for cli gets included in lib.rs via `include_str!`. The code snippets then get assumed to be Rust, which fails if running `cargo test --doc`. This is not a huge problem, but was brought to my attention because Nix's `buildRustPackage` runs `cargo test` including doc tests (unlike what get run for this project on CI). This means I can't update the Nix package to 0.4.3 without changing the test flags (which I think I'll see about doing anyways, as that's how Dioxus runs CI).
72 lines
2.0 KiB
Markdown
72 lines
2.0 KiB
Markdown
<div style="text-align: center">
|
|
<h1>📦✨ Dioxus CLI</h1>
|
|
<p><strong>Tooling to supercharge Dioxus projects</strong></p>
|
|
</div>
|
|
|
|
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)
|
|
|
|
```shell
|
|
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.
|
|
|
|
```shell
|
|
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
|
|
|
|
```shell
|
|
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](https://github.com/DioxusLabs/dioxus-template) repository.
|
|
|
|
Alternatively, you can specify the template path:
|
|
|
|
```shell
|
|
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:
|
|
|
|
```toml
|
|
[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](https://dioxuslabs.com/learn/0.4/CLI/configure).
|