Skip to content

Update README with cleanup instructions for stor #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Throdne wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README with cleanup instructions for stor #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,21 @@ To see what will be changed, use `-n` or `--simulate` before you execute any act
stor -n modules/*/
```

In a rare case, default files might already exist before you stor a module.
For example, `dotfiles/plasmazones/.config/plasmazones/config.json` already exist before running stor but you want to cleanup the directory before symbolic linking.

To remove the current files and then link
```shell
stor -R -f plamsazones
```

Example output
```shell
❯ stor -R -f plasmazones/
[INFO] Delete: /$HOME/.config/plasmazones/config.json
[INFO] Link: /$HOME/dotfiles/plasmazones/.config/plasmazones -> /$HOME/.config/plasmazones
```

## Advanced

Stor allows per-module configuration via a stor.toml file located at the root of each module (e.g., `<module_name>/stor.toml`).
Expand Down