2021-07-07 16:54:14 -04:00
< div align = "center" >
2022-07-09 22:17:32 +08:00
< h1 > 📦✨ Dioxus CLI < / h1 >
2022-10-02 02:28:25 -04:00
< p > < strong > Tooling to supercharge Dioxus projects< / strong > < / p >
2021-07-07 16:54:14 -04:00
< / div >
2022-11-30 13:51:23 -08:00
**dioxus-cli** (inspired by wasm-pack and webpack) is a tool for getting Dioxus projects up and running. It handles all of the build, bundling, development and publishing to simplify web development.
2021-07-07 16:54:14 -04:00
2021-12-29 11:57:30 -05:00
2022-11-30 13:51:23 -08:00
## Installation
2022-01-09 00:23:58 -05:00
2022-11-30 13:51:23 -08:00
### Install stable version
2022-10-02 02:28:25 -04:00
```
cargo install dioxus-cli
```
2022-11-30 13:51:23 -08:00
### Install from git repository
2022-10-02 02:28:25 -04:00
```
cargo install --git https://github.com/DioxusLabs/cli
```
2022-11-30 13:51:23 -08:00
### Install from local folder
2022-10-02 02:28:25 -04:00
```
cargo install --path . --debug
2022-01-09 00:23:58 -05:00
```
2022-02-05 09:11:44 +08:00
## Get Started
2022-11-30 13:51:23 -08:00
Use `dioxus create project-name` to initialize a new Dioxus project. < br >
2022-10-02 02:28:25 -04:00
It will be cloned from the [dioxus-template ](https://github.com/DioxusLabs/dioxus-template ) repository.
< br >
2022-02-05 09:11:44 +08:00
2022-10-02 02:28:25 -04:00
Alternatively, you can specify the template path:
2022-02-05 09:11:44 +08:00
```
dioxus create hello --template gh:dioxuslabs/dioxus-template
2022-02-18 09:50:26 +08:00
```
2022-11-30 13:51:23 -08:00
## Dioxus Config File
2022-12-01 09:17:03 -08:00
Dioxus CLI will use `Dioxus.toml` file to Identify some project info and switch some cli feature.
You can get more configure information from [Dioxus CLI Document ](https://dioxuslabs.com/cli/configure.html ).