2
0
Fork 0
mirror of https://github.com/DioxusLabs/dioxus synced 2024-12-21 01:53:15 +00:00
dioxus/packages/cli/README.md

72 lines
2 KiB
Markdown
Raw Normal View History

Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
<div style="text-align: center">
<h1>📦✨ Dioxus CLI</h1>
2022-10-02 06:28:25 +00:00
<p><strong>Tooling to supercharge Dioxus projects</strong></p>
2021-07-07 20:54:14 +00:00
</div>
Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
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.
2021-12-29 16:57:30 +00:00
2022-11-30 21:51:23 +00:00
## Installation
2022-01-09 05:23:58 +00:00
Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
### Install the stable version (recommended)
2022-10-02 06:28:25 +00:00
```
cargo install dioxus-cli --locked
2022-10-02 06:28:25 +00:00
```
Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
### 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.
2022-10-02 06:28:25 +00:00
```
2023-06-29 00:39:03 +00:00
cargo install --git https://github.com/DioxusLabs/dioxus dioxus-cli
2022-10-02 06:28:25 +00:00
```
Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
This will download the CLI from the master branch,
and install it in Cargo's global binary directory (`~/.cargo/bin/` by default).
2022-11-30 21:51:23 +00:00
### Install from local folder
2022-10-02 06:28:25 +00:00
```
cargo install --path . --debug
2022-01-09 05:23:58 +00:00
```
Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
## Get started
2022-02-05 01:11:44 +00:00
Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
Use `dx create project-name` to initialize a new Dioxus project.
2022-10-02 06:28:25 +00:00
It will be cloned from the [dioxus-template](https://github.com/DioxusLabs/dioxus-template) repository.
Alternatively, you can specify the template path:
2022-02-05 01:11:44 +00:00
```
dx create hello --template gh:dioxuslabs/dioxus-template
2022-02-18 01:50:26 +00:00
```
2022-11-30 21:51:23 +00:00
Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
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:
Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
```toml
[application]
name = "project-name"
# Currently supported platforms: web, desktop
default_platform = "web"
2022-11-30 21:51:23 +00:00
Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
[web.app]
title = "Hello"
[web.watcher]
[web.resource.dev]
```
2022-12-01 17:17:03 +00:00
Improve CLI docs (#1404) * Improve CLI docs * Fixed all the typos (hopefully). * Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter. * Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion. * Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`. * Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting. * And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost. * Fix grammar in packages/cli/docs/src/creating.md Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com> * Update README.md * Change config example --------- Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 22:59:20 +00:00
The full anatomy of `Dioxus.toml` is shown on the [Dioxus website](https://dioxuslabs.com/learn/0.4/CLI/configure).