dof

README

# dof

image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0"]
image:https://github.com/steffakasid/dof/actions/workflows/codeql-analysis.yml/badge.svg[link:https://github.com/steffakasid/dof/actions/workflows/codeql-analysis.yml]
image:https://github.com/steffakasid/dof/actions/workflows/release.yml/badge.svg[link:https://github.com/steffakasid/dof/actions/workflows/release.yml]
image:https://github.com/steffakasid/dof/actions/workflows/go-test.yml/badge.svg[link:https://github.com/steffakasid/dof/actions/workflows/go-test.yml]

This little tool can be used to manage dot file based on a git bare repository. The basic manual process is described e.g. https://www.atlassian.com/git/tutorials/dotfiles

## todo

* make it easier to intialize a new repo e.g. use an argument to directly set the remote

## how to use

### Initialize a new repository

If you want to initialize a new repo you could just run `dof init`. This will basically setup a local git repository which can be used to add the dot files via `dof add .dotfilename`. Right now you have to manually add a remote to be able to publish the dot file repository e.g. to github. You can do this with the following command `dof alias remote add origin <path-to-git-remote-repo>`, `git config --global init.defaultBranch main` and `dof alias branch set-upstream-to origin/main main`. Afterward you can run `dof sync` to push all add files to the remote.

### Checkout and setup an existing dot file repository

If you want to checkout an existing repository you can just run `dof checkout <git-remote-repo>`. This command will checkout the repository as a bare repo. Afterwards it will identify all included dot files, rename them and run a checkout on the bare repo. Afterwards you will have your dotfiles setup in your home directory from the dot file repo.

## github actions

This repo uses https://github.com/marketplace/actions/go-release-binaries to build go binaries

Documentation

Overview

Copyright © 2020 Steffen Rumpf <github@steffen-rumpf.de>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.