Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 2.56 KB

readme.md

File metadata and controls

77 lines (58 loc) · 2.56 KB
Raw

mine

If you're a fan of sticky notes, this could be for you.

mine uses a global ignore 🌐 along with a handful of bash functions to let you keep personal, backup-able notes 📝 and repo-related records with your repo and insulated from its history.

about

an example:

                                       yours?
hypothetical_repo/
    readme.md
    _mine_AWSloginInfo                 ✓
    usabilityIdeas_mine_               ✓
    bin/
        build
        generate
        fixEveryonesWhitespace_mine_   ✓
    src/
        main.file
        ...
    _mine_/                            ✓
        notes                          ✓
        todays-todo                    ✓
    ...

the mine command along with the _mine_ files leave you free to

🔐 keep login info for a related service with your repo — 📝 leave notes for yourself about where you left off and what to do later — 🏃 work with a slapdash script until you get a real one together — ✅ maintain a personal todo list — 💨 remove all your personal files in an instant (perhaps before you ftp or rsync) — 📃 store curled or pasted code for personal reference — 🔗 store a collection of useful links that would otherwise clutter the history.

commands

  • mine snap - take a snapshot of your current _mine_ files
  • mine restore - restore the last snapshot
  • mine clean - remove all _mine_ files from your repo
  • mine purge - purge all mine files from the current project and backups
  • mine touch - an alternative to touch fileName_mine_
  • mine list - list the files under mine's aegis
  • mine help

get it

git clone https://github.com/atstp/mine.git ~/.mine
cd ~/.mine
bash ./configure
# exit and reopen your terminal

mercurial users: after running ./configure, add a rule to globally ignore *_mine_* files, in the syntax: glob section

update it

cd ~/.mine
git pull

license

MIT

colophon

The "users" will likely be myself, but it's here for anyone who finds it useful. This thing came about naturally for me: a local ignore, then a global ignore, followed by a few convenience commands, now it's wrapped up here :octocat:. If you've got an idea to make it more natural or intuitive, let me know with an issue or a pull request. Enjoy!