https://github.com/brickfrog/crystow
https://github.com/brickfrog/crystow
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/brickfrog/crystow
- Owner: brickfrog
- License: mit
- Created: 2024-06-29T19:18:31.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-03T10:54:41.000Z (almost 2 years ago)
- Last Synced: 2025-08-23T12:08:52.688Z (10 months ago)
- Language: Crystal
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CryStow
CryStow (Crystal-like stow) is a tool designed to manage your dotfiles easily, inspired by the simplicity of Crystal.
## Installation
Clone the repository and build the project using:
```bash
crystal build src/crystow.cr
```
## Usage
Run `crystow` with the required options:
```bash
crystal run src/crystow.cr -- -a ~/.config/i3 -d ~/dotfiles/i3 --simulate --verbose
```
### Options
- `-v, --version`: Show the version of CryStow.
- `-s, --simulate`: Simulate the operation without making any changes to the files.
- `--verbose`: Enable verbose output to see more detailed logs.
- `-f, --force`: Force overwrite existing files without asking.
- `-a APP, --app=APP`: Specify the application configuration path you want to manage.
- `-d DEST, --dest=DEST`: Specify the destination path where the dotfiles should be stored.
- `-h, --help`: Display help information.
## Example
To simulate the management of i3 config files without actually copying them:
```bash
./crystow -a ~/.config/i3 -d ~/dotfiles/i3 --simulate --verbose
```
This command will show what changes would be made if the command were executed without the `--simulate` flag.
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request with your features or fixes.
## License
Distributed under the MIT License. See `LICENSE` for more information.