dioxus/README.md

52 lines
1.5 KiB
Markdown
Raw Normal View History

2021-07-07 20:54:14 +00:00
<div align="center">
2022-01-09 05:23:58 +00:00
<h1>📦✨ dioxus-cli </h1>
2022-02-05 01:11:44 +00:00
<p><strong>Tooling to supercharge dioxus projects</strong></p>
2021-07-07 20:54:14 +00:00
</div>
2022-01-22 17:29:36 +00:00
dioxus-cli (inspired by wasm-pack and webpack) is a tool to help get dioxus projects off the ground. It handles all the build, development, bundling, and publishing to make web development simple.
2021-12-29 16:57:30 +00:00
2022-01-09 05:23:58 +00:00
## Installation
2022-02-06 21:28:18 +00:00
```shell
# for stable
2022-01-09 05:23:58 +00:00
$ cargo install dioxus-cli
2022-02-06 21:28:18 +00:00
# for latest
2022-02-09 13:30:00 +00:00
$ cargo install --git https://github.com/DioxusLabs/cli
2022-02-06 21:28:18 +00:00
# for developing
$ cargo install --path . --debug
2022-01-09 05:23:58 +00:00
```
2022-02-05 01:11:44 +00:00
Now, `dioxus` is in your path, you can use `dioxus --help` to get the help document.
```
dioxus 0.1.2
Build, bundle, & ship your Dioxus app
USAGE:
2022-02-18 01:50:26 +00:00
dioxus [FLAGS] <SUBCOMMAND>
2022-02-05 01:11:44 +00:00
FLAGS:
-h, --help Prints help information
-v Enable verbose logging
-V, --version Prints version information
SUBCOMMANDS:
build Build the Rust WASM app and all of its assets
clean Clean output artifacts
config Dioxus config file controls
create Init a new project for Dioxus
help Prints this message or the help of the given subcommand(s)
serve Build, watch & serve the Rust WASM app and all of its assets
translate Translate some source file into Dioxus code
```
## Get Started
2022-02-18 01:50:26 +00:00
You can use the `dioxus create project_name` to init a dioxus project, its will be clone from the [dioxus-template](https://github.com/DioxusLabs/dioxus-template).
2022-02-05 01:11:44 +00:00
or you can assign the template path:
```
dioxus create hello --template gh:dioxuslabs/dioxus-template
2022-02-18 01:50:26 +00:00
```