cube-tui 0.1.6

Terminal UI timer and session manager for speedcubing, with optional web dashboard and BLE (GAN) timer support.
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
106
107
108
109
110

# cube-tui


[![Crates.io](https://img.shields.io/crates/v/cube-tui.svg)](https://crates.io/crates/cube-tui)

A terminal UI timer and session manager for speedcubing.

![teaser](images/main.png)

Out of the box, it's a lightweight TUI timer that lets you time solves, scramble, and check basic stats directly from
your terminal. All your session data is saved locally.

## Requirements


- [Rust & Cargo](https://rustup.rs/)
- [Bun](https://bun.sh/) (required for the `dashboard` feature)
- One of [Node.js](https://nodejs.org/), [Bun](https://bun.sh/) (required for the `wca-scrambles` feature)

## Installation & Features


You can install the app globally using Cargo. By default, it installs the core terminal app without any heavy
dependencies:

```sh
cargo install cube-tui
```

If you want extra functionality, you can enable specific features during installation depending on your setup.

### Dashboard


Spins up a local web server (localhost) with a companion app. This web UI can be used to look at your solve history and
advanced statistics.

To install with the dashboard included:

```sh
cargo install cube-tui --features dashboard
```

*Note: The build script will automatically use Bun to install dependencies and build the web frontend, embedding it
directly into the executable.*

### WCA Scrambles


Uses [cubing.js](https://github.com/cubing/cubing.js) scramble generation for WCA events (instead of the built-in
random generator).

To install with WCA scrambles support:

```sh
cargo install cube-tui --features wca-scrambles
```

When this feature is enabled, cube uses WCA API scrambles by default. If the local scrambles app cannot be started,
it automatically falls back to the built-in random generator.

### Bluetooth


Allows the app to connect directly to Bluetooth Low Energy (BLE) timers. Right now, only the GAN timer is supported.

To install with Bluetooth support:

```sh
cargo install cube-tui --features bluetooth
```

### All Features


If you want dashboard, Bluetooth timer support, and WCA scramble API support:

```sh
cargo install cube-tui --all-features
```

## Usage


Run the terminal app:

```sh
cube
```

To see all the commands run

```sh
cube --help
```

If you installed from source, you can also run it directly from the project root:

```sh
cargo run --release
```

If you installed with the `dashboard` feature, the command:

```sh 
cube dashboard
``` 

will start the app with dashboard support
enabled.

Use a custom port if needed:

```sh
cube dashboard --port 8080
```

The default port is `7799`.