rhai/src/bin/README.md

41 lines
1.3 KiB
Markdown
Raw Normal View History

2020-12-29 08:36:42 +01:00
Rhai Tools
==========
2021-04-22 17:02:25 +02:00
Tools for running Rhai scripts.
2020-12-29 08:36:42 +01:00
2022-01-30 02:41:51 +01:00
| Tool | Required feature(s) | Description |
| -------------------------------------------------------------------------------- | :-----------------: | --------------------------------------------------- |
| [`rhai-run`](https://github.com/rhaiscript/rhai/blob/main/src/bin/rhai-run.rs) | | runs each filename passed to it as a Rhai script |
| [`rhai-repl`](https://github.com/rhaiscript/rhai/blob/main/src/bin/rhai-repl.rs) | `rustyline` | simple REPL that interactively evaluates statements |
| [`rhai-dbg`](https://github.com/rhaiscript/rhai/blob/main/src/bin/rhai-dbg.rs) | `debugging` | the _Rhai Debugger_ |
2020-12-29 08:36:42 +01:00
How to Run
----------
2022-01-30 02:41:51 +01:00
```sh
2020-12-29 08:36:42 +01:00
cargo run --bin sample_app_to_run
```
2022-01-30 02:41:51 +01:00
or with required features
```sh
cargo run --bin sample_app_to_run --features feature1,feature2,feature3
```
How to Install
--------------
To install these all tools (with [`decimal`] and [`metadata`] support), use the following command:
```sh
cargo install --path . --bins --features decimal,metadata,debugging,rustyline
```
or specifically:
```sh
cargo install --path . --bin rhai-run --features decimal,metadata,debugging,rustyline
```