Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/volllly/rotz
Fully cross platform dotfile manager and dev environment bootstrapper written in Rust.
https://github.com/volllly/rotz
cross-platform dotfile-manager dotfiles dotfiles-manager rust
Last synced: 6 days ago
JSON representation
Fully cross platform dotfile manager and dev environment bootstrapper written in Rust.
- Host: GitHub
- URL: https://github.com/volllly/rotz
- Owner: volllly
- License: mit
- Created: 2022-01-25T15:22:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T16:52:58.000Z (13 days ago)
- Last Synced: 2024-10-25T08:29:41.586Z (11 days ago)
- Topics: cross-platform, dotfile-manager, dotfiles, dotfiles-manager, rust
- Language: Rust
- Homepage: https://volllly.github.io/rotz/
- Size: 1.78 MB
- Stars: 348
- Watchers: 4
- Forks: 9
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - volllly/rotz - Fully cross platform dotfile manager and dev environment bootstrapper written in Rust. (Rust)
README
# Rotz 👃
[](https://crates.io/crates/rotz)
[](https://github.com/volllly/rotz/blob/main/LICENSE)
Fully cross platform dotfile manager and dev environment bootstrapper written in Rust.
> `Rust Dotfilemanager`
> `Rust Dotfile manager`
> `Rust Dotfile s`
> `Rust Dot s`
> `R ust Dots`
> `R ots`
> `Rot s`
> `Rotz`
## [🗺️ Roadmap](https://github.com/users/volllly/projects/1/views/1)
## [📖 Documentation](https://volllly.github.io/rotz/)
## Overview
Rotz has three main functionalities:
1. Linking dotfiles from a common repository to your system
2. Installing the applications you need to start working on an new/empty machine
3. Full Cross platform functionality [See Configuration](https://volllly.github.io/rotz/docs/configuration/os-specific-configuration)
## Installation
### Homebrew
On Linux and MacOS you can install Rotz using [Homebrew](https://brew.sh/).
```sh
brew install volllly/tap/rotz
```
### Scoop
On Windows you can install Rotz using [Scoop](https://scoop.sh/).
```pwsh
scoop bucket add volllly https://github.com/volllly/scoop-bucket
scoop install volllly/rotz
```
### Cargo
You can install Rotz using cargo everywhere if Rust is installed.
```bash
cargo install rotz
```
#### File Formats
Rotz uses [`yaml`](https://yaml.org/), [`toml`](https://toml.io/) or [`json`](https://www.json.org/) configuration files per default.
> ***Note:** Rotz will auto detect the correct filetype.*
You can install rotz with support for only one of the filetypes by using the `--features` flag.
* ```sh
cargo install rotz --no-default-features --features toml
```
* ```sh
cargo install rotz --no-default-features --features json
```
## Installer scripts
```sh
curl -fsSL volllly.github.io/rotz/install.sh | sh
```
```pwsh
irm volllly.github.io/rotz/install.ps1 | iex
```
## Getting Started
If you already have a `dotfiles` repo you can clone it with the `rotz clone` command.
```sh
rotz clone [email protected]:/.git
```
To bootstrap your dev environment use `rotz install`.
To link your `dotfiles` use `rotz link`.
## Usage
Run `rotz --help` to see all commands Rotz has.
## Contribute
Feel free to create pull requests and issues for bugs, features or questions.