dotctl

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 4, 2024 License: GPL-3.0 Imports: 1 Imported by: 0

README

Dotctl

A cli tool to manage your dotfiles

About

Dotctl is a tool to help you easily manage your dotfiles and sync them across separate machines using git. It aims to abstract away the manual effort of symlinking your dotfiles to config directories and updating them with git.

Installation

  • TBD

Usage

# init sets up the config file and directory to hold all dotfiles
dotctl init
# add a config directory for dotctl to track
dotctl add ~/.config/nvim
# create symlinks
dotctl link
# sync changes
dotctl sync -r <your-git-repo>

Development

It's preferable to create a temporary directory and copy your system's config directory over to avoid making undesirable changes to your system. A couple of useful makefile scripts exist to set up and tear down this. It will create a testing directory in ./tmp/config and copy your system configs over.

make sandbox # creates the directory and copies over from ~/.config
make clean # removes directory

Documentation

Overview

Copyright © 2024 NAME HERE <EMAIL ADDRESS>

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳