shlf 0.4.1

A command-line tool for managing config & dotfiles
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
106
107
108
109
110

# Shelf - Dotfile Manager

[![Shelf CI](https://github.com/ab22593k/shelf/actions/workflows/ci.yml/badge.svg)](https://github.com/ab22593k/shelf/actions/workflows/ci.yml)

Shelf is a command-line tool for managing and syncing dotfiles across different machines. It allows you to track, list, remove, and sync your dotfiles with ease.

## Features

- Track dotfiles from anywhere in your file system
- List all tracked dotfiles
- Remove dotfiles from tracking
- Sync dotfiles to a specified directory or default location

## Installation

To install Shelf, you need to have Rust and Cargo installed on your system. If you don't have them, you can install them from [rustup.rs](https://rustup.rs/).

Once you have Rust and Cargo installed, you can build and install Shelf using the following command:

```
cargo install --path .
```
## Usage

Shelf provides several commands to manage your dotfiles:

```bash
# Add a new dotfile to track
shlf add ~/.bashrc

# List all tracked dotfiles
shlf ls

# Remove a dotfile from tracking
shlf rm .bashrc

# Create symlinks for all tracked dotfiles
shlf link

# Interactive selection of dotfiles to track
shlf suggest

# Show help
shlf --help
```

Each command can be run with `-h` or `--help` for more information.

# Push dotfiles to a remote Git repository
shlf push --repo username/dotfiles --token your_access_token --branch main

# Pull dotfiles from a remote Git repository
shlf pull

## Shell Completion

Shelf supports generating shell completion scripts for various shells. You can generate these scripts using the `completion` subcommand:

```bash
# Generate completion script for Bash
shlf completion bash > shlf.bash

# Generate completion script for Zsh
shlf completion zsh > _shlf

# Generate completion script for Fish
shlf completion fish > shlf.fish
```

To use the completion scripts:

- For Bash, add the following line to your `~/.bashrc`:
  ```bash
  source /path/to/shlf.bash
  ```

- For Zsh, place the `_shlf` file in `~/.zfunc`, don't forget to add `source ~/.zfunc/*` in `~/.zshrc`.

- For Fish, place the `shlf.fish` file in `~/.config/fish/completions`.

After setting up the completion script, restart your shell or source the respective configuration file to enable completions for the `shlf` command.

## Development

To build the project locally:

```
cargo build
```

To run tests:

```
cargo test
```
To run the project directly without installing:

```
cargo run -- [SUBCOMMAND]
```

Replace `[SUBCOMMAND]` with the command you want to run, such as `add`, `ls`, `rm`, or `link`.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the LICENSE file for details.