bath 0.3.1

A TUI tool to manage and export environment variable profiles
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

<h1 align="center">bath 🚿</h1>

<p align="center">
  <a href="https://github.com/4thel00z/bath/actions/workflows/ci.yml">
    <img alt="CI" src="https://github.com/4thel00z/bath/actions/workflows/ci.yml/badge.svg" />
  </a>
  <a href="https://crates.io/crates/bath">
    <img alt="Crates.io" src="https://img.shields.io/crates/v/bath.svg" />
  </a>
  <a href="https://github.com/4thel00z/bath/blob/master/LICENSE">
    <img alt="License" src="https://img.shields.io/github/license/4thel00z/bath" />
  </a>
</p>

`bath` is a terminal UI (TUI) tool for managing environment-variable profiles (e.g. `PATH`, compiler flags, and linker flags) backed by SQLite.

## Features

- **Profiles in SQLite**: store multiple named profiles and switch/export them consistently
- **Interactive TUI**: edit variables with live preview of the resulting export output
- **Export for shell eval**: print `export ...` statements for the selected profile
- **Modes**: prepend/append/replace behavior per variable

## Installation

```bash
cargo install bath
```

## Usage

- **TUI mode**:

```bash
bath
```

- **Export a profile**:

```bash
bath export my_profile
```

- **Eval in your shell**:

```bash
eval "$(bath export my_profile)"
```

- **Choose export mode** (`prepend` is default):

```bash
bath export my_profile --mode append
```

## Data storage

Bath stores profiles in a SQLite database at:

- `~/.bath.db`

## Development

### pre-commit hooks

This repository includes a `.pre-commit-config.yaml` to run basic checks locally (formatting, clippy, tests).

```bash
pipx install pre-commit
pre-commit install
pre-commit run -a
```

### CI

GitHub Actions runs the following on every push and pull request:

- `cargo fmt --check`
- `cargo clippy -- -D warnings`
- `cargo test`

### Releasing (crates.io)

Releases are automated with `release-plz` (it opens a release PR and publishes to crates.io after merge).

- **Required GitHub setting**: in `Settings → Actions → General`, set workflow permissions to allow GitHub Actions to create and approve pull requests. See the official quickstart: https://release-plz.dev/docs/github/quickstart
- **Required secret**: `CARGO_REGISTRY_TOKEN` (crates.io token with scopes `publish-new` and `publish-update`), used by `.github/workflows/release-plz.yml`.

## License

GPL-3.0. See `LICENSE`.