dioxus/packages/cli
Miles Murgaw 8d68886310
CLI Fixes & Tweaks (#2846)
Fixes scrolling on vscode using simple fix
 Adds scroll modifier, scroll at 5 lines per scroll while holding shift key.
 Adds error handling for manganis failure that still lets the build run.
 Revises TUI rendering code.
 Move TUI "info bars" to the bottom of the terminal.
 Revised logging system with tracing
 Working [c] clear keybind. This has been removed.
 Removal of [h] hide keybind text (it does nothing)
 Some opinionated cleanups and renames to make tui logic easier to understand.
 Rolling log file & maybe add some more "internal" logging. Closes CLI Rolling Log File #2764
 Removes log tabs. Closes CLI: Color-code logs and get rid of tabs #2857
 Combines info bars.
 Working and good text selection.
 Print launch URL in console.
 Handle log lines properly and add formatting.
 Move MessageSource to a more reasonable location.
 Add some background styling to powerline (info bar) - Tried this and it doesn't look the greatest.
 Log Filtering
 Final Cleaning & Changes - I could do this forever
 Test Linux

---------

Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>
2024-09-13 01:34:19 -07:00
..
.vscode Prepare CLI for move into mainline 2023-06-28 17:21:23 -07:00
assets Fix: Make Toast Fixed & Increase Z-Index (#2850) 2024-08-16 10:54:35 -07:00
src CLI Fixes & Tweaks (#2846) 2024-09-13 01:34:19 -07:00
tests fix hotreloading issues in the CLI 2024-03-12 13:39:42 -07:00
.gitignore Prepare CLI for move into mainline 2023-06-28 17:21:23 -07:00
build.rs Hotreloading of for/if/body, formatted strings, literals, component props, nested rsx, light CLI rewrite, cli TUI (#2258) 2024-07-17 19:11:18 -07:00
Cargo.toml CLI Fixes & Tweaks (#2846) 2024-09-13 01:34:19 -07:00
Dioxus.toml Add a deprecation warning for the resource option in dioxus.toml (#2642) 2024-07-24 17:52:28 -07:00
README.md Fix cli readme local installation instructions (#2671) 2024-07-23 10:57:51 -07: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 building, bundling, development and publishing to simplify development.

Installation

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.

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

Note: The CLI will fail to build projects in debug profile. This is currently under investigation.

cargo install --path .

Developing The CLI

It's faster to build the CLI using the cli-dev profile when testing changes.

cargo build --profile cli-dev

Get started

Use dx new to initialize a new Dioxus project. It will be cloned from the dioxus-template repository.

Alternatively, you can specify the template path:

dx new --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.