HackNow
Utility for automation of project directories and switching workspaces based on the GitHub directory structure - User/Project
Functionality
- Directory structure:
<projects-dir>/<user>/<repo>
- Checks if a directory for the specified repo exists
- No: Clones github repo into new directory
- Yes: Does
git fetch --all
for this repo - Then changes into the project directory
Getting started
Available on npm:
npm i -g hacknow
Shell function
If you want your shell to switch into the project directory, you need to create a small function inside your shell config (.bashrc
, .zshrc
or similar)
Choose a different alias if hn
doesn't work for you.
Please note: On failure hacknow will echo just .
to stdout, so it should be safe to call cd
on it in every situation.
Usage
hacknow <user>/<repo> # Plain (without dir change) hn <user>/<repo> # Needs a shell function (see above) cd $(hacknow <user>/<repo>) # Alternative if the shell function does not work for you
Options
-d|--project-dir <dir> Choose base directory for your projects (default: $HOME)
--ssh Use ssh protocol for git remote
Examples
$ hn mraerino/gitmoji$ hn mraerino/hacknow -d ~/src$ hn festify/app --ssh
Ideas / Roadmap
- Bash completion
- Execute scripts inside project directory (like
nvm
,virtualenv
,yarn install
, IDE launch...)