cargo-run 0.1.0

A CLI tool to run custom scripts in Rust, defined in Scripts.toml
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

# cargo-run

<!-- prettier-ignore-start -->

[![crates.io](https://img.shields.io/crates/v/cargo-run?label=latest)](https://crates.io/crates/cargo-run)
[![Documentation](https://docs.rs/cargo-run/badge.svg)](https://docs.rs/cargo-run)
[![Documentation](https://docs.rs/cargo-run/badge.svg?version=0.1.0)](https://docs.rs/cargo-run/0.1.0)
![Version](https://img.shields.io/badge/rustc-1.79+-ab6000.svg)
![MIT or Apache 2.0 licensed](https://img.shields.io/crates/l/cargo-run.svg)
<br />
[![Dependency Status](https://deps.rs/crate/cargo-run/0.1.0/status.svg)](https://deps.rs/crate/cargo-run/0.1.0)
[![Download](https://img.shields.io/crates/d/cargo-run.svg)](https://crates.io/crates/cargo-run)

<!-- prettier-ignore-end -->

<!-- cargo-rdme start -->

A CLI tool to run custom scripts in Rust, defined in `Scripts.toml`.

## Features

-   Run scripts defined in `Scripts.toml`.
-   Specify interpreters for scripts (e.g., bash, zsh, PowerShell).
-   Initialize a `Scripts.toml` file with default content.
-   Chain multiple scripts together using the `include` feature.

## Installation

To install `cargo-run`, use the following command:

```sh
cargo install cargo-run
```

## Usage

To run a script, use the following command:

```sh
cargo-script <option> <script_name>
```

Or

```sh
cgs <option> <script_name>
```

Complete script:

```sh
cgs run <script_name>

// Or

cargo-script run <script_name>
```

## Scripts Examples

The `Scripts.toml` file is used to define scripts. The file is located in the root of the project directory. The following is an example of a `Scripts.toml` file:

```toml
[scripts]
# run a shell script
run_shell = "./.scripts/i_am_shell.sh"
# run a shell script with interpreter, also add script info
config = { interpreter = "bash", command = "echo 'test'", info = "Script to test" }
# run inline script
build = "echo 'build'"
# run chain of scripts
release = { include = ["i_am_shell", "build"] }
```

<!-- cargo-rdme end -->