https://github.com/daniel-white/twist

A dotfile manager with a twist
https://github.com/daniel-white/twist

dotfiles rust

Last synced: 3 months ago
JSON representation

A dotfile manager with a twist

• Host: GitHub
• URL: https://github.com/daniel-white/twist
• Owner: daniel-white
• License: mit
• Created: 2021-07-07T00:01:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T22:14:11.000Z (3 months ago)
• Last Synced: 2024-11-02T16:51:35.404Z (3 months ago)
• Topics: dotfiles, rust
• Language: Rust
• Homepage:
• Size: 733 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Twist

> Work in progress

## A dotfile manager with a twist

Twist is a dotfile manager for Linux and macOS, inspired by [Dotdrop](https://github.com/deadc0de6/dotdrop).

The goal of Twist is to make dotfiles management easier and more fun.

Twist is written in Rust, so no additional runtime dependencies are required.

Out of the box, Twist will create and manage a Git repository for your dotfiles.

The CLI was modeled after the Git CLI. All options are documented with `--help`.

| Command        | Info                                                                                            |

| -------------- | ----------------------------------------------------------------------------------------------- |

| `twist git`    | Executes a Git command inside of the Twist Git repository. An escape hatch.                     |

| `twist init`   | Initializes a new Twist repository.                                                             |

| `twist add`    | Adds or updates the specified files or directories into the repository and commits the changes. |

| `twist rm`     | Removes the specified files or directories from the repository and commits the changes.         |

| `twist update` | Updates the tracked files and directories into the repository and commits the changes.          |

| `twist apply`  | Restores the tracked files and directories into their original locations.                       |

| `twist push`   | Pushes the changes to the remote repository.                                                    |

| `twist pull`   | Pulls the changes from the remote repository.                                                   |

## Roadmap

### v1

- Implement all basic commands

- Profile support

- Improved testing

### vNext

- Plugin or package support

  - Generate files for dynamic resources (as well as restoring these)

  - Think like tracking installed Homebrew packages