bonds-cli 0.1.0

CLI for creating and managing symlink-based bonds
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

# bonds

A tool for creating and managing "bonds" between files and directories.

> Build with [symlinks](https://en.wikipedia.org/wiki/Symbolic_link) and a [SQLite](https://www.sqlite.org/)
>> Inspired by [GNU Stow](https://www.gnu.org/software/stow/)

## Status

- [x] Basic core & CLI
- [ ] Library API
- [ ] GUI application
- [ ] Ecosystem & plugins

---

### Usage

- [Creating a bond](#creating-a-bond)
- [Listing bonds](#listing-bonds)
- [Inspecting bond details](#inspecting-bond-details)
- [Removing a bond](#removing-a-bond)
- [Updating a bond](#updating-a-bond)
- [Migrating bonds](#migrating-bonds)
- [Configuration](#configuration)

---

##### Creating a bond

```bash
# default target: ~/bonds
bond add ~/projects/my-app # creates a bond from ~/projects/my-app to ~/bonds/my-app
# custom target
bond add ~/projects/my-app ~/my-app-link
# bulk bond all contents of a directory
bond add ~/projects/ ~/bonds --contents # creates bonds for each child of ~/projects
# with a name
bond add ~/projects/my-app --name foo
```

##### Listing bonds

```bash
bond list
# OUTPUT:
# foo (abc12345)  -  ~/projects/my-app -> ~/bonds/my-app  (2026-04-06 12:00)
```

##### Inspecting bond details

```bash
bond info foo
# OUTPUT:
# ID: abc12345
# Source: ~/projects/my-app
# Target: ~/bonds/my-app
# Created At: 2026-04-06 12:00
# Health: Healthy (symlink intact)
```

##### Removing a bond

```bash
# remove by ID
bond remove abc12345
# remove by (specified) name
bond remove foo
# To also delete the target, use:
bond remove foo --with-target
```

##### Updating a bond

```bash
# Update source and/or target
bond update foo --source ~/new-source/my-app
bond update foo --target ~/new-target/my-app
# Update name
bond update foo --name new-name
```

##### Migrating bonds

```bash
# Move bond to a new default location (with auto-backup)
bond migrate foo ~/new-default-bonds/
# if the bond is located in a different location, you can run
bond migrate foo
# will automatically move the bond to the current default location (e.g., ~/bonds/)
```

##### Configuration

```bash
# Set default target directory
bond config set default ~/my-default-bonds
# Get current default target directory
bond config get default
```