codemonument_bx 0.3.5

[DEPRECATED: Use `bx-cli` instead] Simple, cross-platform, and fast command aliases with superpowers.
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

<h1 align="center">bx</h1>

> **DEPRECATION NOTICE**: The `codemonument_bx` crate has been renamed to [`bx-cli`](https://crates.io/crates/bx-cli).
> Please update your installation:
> ```bash
> cargo install bx-cli
> ```

---

[![Test](https://github.com/codemonument/bx/actions/workflows/ci.yml/badge.svg)](https://github.com/codemonument/bx/actions/workflows/ci.yml)
[![Build and Release](https://github.com/codemonument/bx/actions/workflows/cd.yml/badge.svg)](https://github.com/codemonument/bx/actions/workflows/cd.yml)

> **Simple, cross-platform, and fast command aliases with superpowers.**

A fork of [Bonnie](https://github.com/arctic-hen7/bonnie) with a shorter command name.

[Documentation][docs] | [Releases][releases]

## Why "bx"?

- **Short**: Only 2 characters to type (vs 6 for "bonnie")
- **Unique**: Fairly unused command name in the Linux world
- **Meaningful**: Can stand for "bonnie execute" or "Benny execute"

## Features

- Simple **key-value aliasing**
- **Custom arguments** interpolation
- **Environment variable** interpolation
- Different commands on different **operating systems**
- **Custom shells** for individual commands
- **Infinitely nestable subcommands**
- Subcommands executed based on **exit codes**
- **Caching** for large config files
- Config file **templates**
- **Debug** mode

## Quick Start

The simplest `bx.toml` (or `bonnie.toml`) configuration:

```toml
version = "0.3.2"

[scripts]
build = "echo Building"
test = "cargo test"
```

Run with:
```bash
bx build
bx test
```

## Installation

### From Cargo
```bash
cargo install bx-cli
```

### From Releases
Download pre-built binaries from the [releases page][releases] for:
- Linux (amd64)
- macOS (amd64, arm64)
- Windows (amd64)
- musl (Alpine Linux)

After downloading, move the binary to your PATH (e.g., `/usr/local/bin` on Linux/macOS) and make it executable:
```bash
chmod +x bx
sudo mv bx /usr/local/bin/
```

### In Docker
```Dockerfile
RUN curl -L https://github.com/codemonument/bx/releases/download/[VERSION]/bx-[OS]-amd64 -o /usr/local/bin/bx && chmod +x /usr/local/bin/bx
```

Replace `[VERSION]` with the version (e.g., `v0.3.4`) and `[OS]` with `linux` or `musl`.

## Configuration

bx looks for configuration in this order:
1. `BX_CONF` environment variable
2. `bx.toml` in current directory
3. `BONNIE_CONF` environment variable
4. `bonnie.toml` in current directory

## Documentation

For full documentation on all features (subcommands, environment variables, shells, etc.), see the [Bonnie documentation][docs].

## License

MIT - See [LICENSE](./LICENSE)

## Credits

Based on [Bonnie](https://github.com/arctic-hen7/bonnie) by arctic_hen7.

[docs]: https://github.com/arctic-hen7/bonnie/wiki
[releases]: https://github.com/codemonument/bx/releases