wcarhart / konphig

Config files for safe keeping 😏

konphig

Config files for safe keeping 😏

Summary

Konphig contains custom settings for common UNIX tools. You can think of it as a dotfiles repo, with some extra bells and whistles.

Documentation: read konphig's full documentation

Installation: see install

Key Features

Konphig comes packed out of the box with tons of cool functionality. Here are a few highlights.

A powerful CLI

Pull multiple registered repositories at once

kn repo --pull

Pulling birdhouse...
Pulling koi...
Pulling lurker...

Add Homebrew, Yarn, and other packages to track in version control

kn new --brew yarn

Added brew formula 'yarn' to konphig

Helpful Bash functions

Join a list of strings

merge '-' 'a b' c d

a b-c-d

Add a permanent alias on the fly

adda e echo
e 'Hello, konphig!'

Hello, konphig!

Move up and down directories

pwd
# /dir0/dir1/dir2/dir3/dir4
up 4
# /dir0
down 2
# /dir0/dir1/dir2

Clever Git extras

Remove local branches not present in the remote

git clean

Review local commits not present in the current branch in the remote

git local

Get the commits for the last sprint

git sprint

Get the primary authors for the repository

git leaderboard

Get all available git aliases

git alias

Much, much more

Reset the macOS Touch Bar

resetbar

Get your public IP address

publicip

Change your command prompt on the fly

dp 5    # change to 'different prompt' #5

Documentation

Read more information in konphig's complete documentation.

Install

To install konphig, use the following:

1. Install kn with Homebrew.

brew install wcarhart/tools/kn

2. Clone this repository.

git clone https://github.com/wcarhart/konphig.git ~/konphig

3. Initialize kn to point to your local repository (if you cloned konphig to somewhere other than ~/konphig, make sure you pass in the correct path).

kn init ~/konphig

4. Install konphig via kn.

kn install

5. To complete the installation, the final step is to source your .bashrc.

source ~/.bashrc

Konphig should now be installed! You can interact with konphig via the kn CLI. To get started, use kn --help.

For more information, head over to konphig's complete documentation.