Skip to content

siteopsio/quicknote

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QuickNote - Turn out notes on a dime

A commandline application to manage your notes.

Inspired by todo.sh.

Getting Started

  • Install

    git clone https://github.com/bsmith89/quicknote.git
    cd quicknote
    ln -s quicknote /somewhere/in/your/PATH
    
  • Customize

    cp quicknote.cfg ~/.quicknote.cfg
    # edit .quicknote.cfg
    # put new/overriding actions into ~/.quicknote.addons.d
    
  • Bootstrap

    quicknote bootstrap
    
  • Add remote

    quicknote git remote add origin [url]
    quicknote push -u origin master
    
  • Get help

    quicknote help
    

Requirements

  • git
  • bash

(Planned) Features

  • Archive notes
  • Identify notes with only a unique prefix
  • Doctor: diagnose problems
  • Bootstrap setup
  • Git integration
  • Help system
  • Easily customizable and extensible
  • Documentation (90% there)
  • Bash completion
  • Prettier grep output
  • Speed optimization
  • Add README.md example note to bootstrapped setups
  • Name the process correctly on quicknote edit

About

Turn out notes on a dime

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%