projecthelper

Project Helper

Project Helper helps you structure your projects on your filesystem.

If you like your projects to be structured like this, that this CLI tool is for you!

❯ tree -L 3 ~/src
/home/dries/src
└── github.com
    ├── nousefreak
    │   ├── projecthelper
    │   └── warpdir
    └── stenic
        ├── k8status
        └── ledger

I use ~/src as the basedir for all my projects.

Install

# Download the binary
go install github.com/nousefreak/projecthelper@latest
# Install the ph alias
projecthelper install

Commands

# Run setup (manages `.config/projecthelper/config.yaml`
ph setup

# Clone to `${basedir}/github.com/nousefreak/projecthelper`
ph clone https://github.com/nousefreak/projecthelper

# Clones all repos (set `GITHUB_TOKEN` to include private)
ph org github.com/nousefreak

# Open a fuzzyfinder that will `cd` to the repo
ph go [search]

# Shorthand for `ph go`
ph [search]

# Run a `git fetch` on all repos
ph update

# Show commits made to any repository in the last 2 days
ph wdid 2 days

Config

# The root of all projects
basedir: /home/username/src

# Rename repository hosts to an alias for using different ssh keys
renameRepo:
  gh-personal: github.com/nousefreak
  gh-work: github.com/stenic

# Add extra static directories outside of the basedir
extraDirs:
  - /home/username/.config/nvim