https://github.com/pforret/note

Manage your notes, todo, ... with this nifty script CLI/bash
https://github.com/pforret/note

bash bashew notes scripting shell-scripting

Last synced: 2 months ago
JSON representation

Manage your notes, todo, ... with this nifty script CLI/bash

• Host: GitHub
• URL: https://github.com/pforret/note
• Owner: pforret
• License: mit
• Created: 2020-12-14T18:10:06.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-02-05T21:15:13.000Z (over 4 years ago)
• Last Synced: 2025-04-10T16:07:02.233Z (6 months ago)
• Topics: bash, bashew, notes, scripting, shell-scripting
• Language: Shell
• Homepage:
• Size: 1.23 MB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![bash_unit CI](https://github.com/pforret/note/workflows/bash_unit%20CI/badge.svg)

![Shellcheck CI](https://github.com/pforret/note/workflows/Shellcheck%20CI/badge.svg)

![GH Language](https://img.shields.io/github/languages/top/pforret/note)

![GH stars](https://img.shields.io/github/stars/pforret/note)

![GH tag](https://img.shields.io/github/v/tag/pforret/note)

![GH License](https://img.shields.io/github/license/pforret/note)

[![basher install](https://img.shields.io/badge/basher-install-white?logo=gnu-bash&style=flat)](https://basher.gitparade.com/package/)

# pforret/note

![](note.jpg)

Manage your notes, todo, ... with this nifty script (100% bash)

## Usage

```

### USAGE

Program: note 1.3.0 by peter@forret.com

Updated: Feb  5 21:57:53 2021

Description: keep track of daily notes

Usage: note [-h] [-q] [-v] [-f] 

            [-n ] [-l ] 

            [-e ] [-t ] [-p ] [-z ] 

             

Flags, options and parameters:

    -h|--help        : [flag] show usage [default: off]

    -q|--quiet       : [flag] no output [default: off]

    -v|--verbose     : [flag] output more [default: off]

    -f|--force       : [flag] do not ask for confirmation (always yes) [default: off]

    -n|--note_dir >: [option] folder for note files   [default: /Users/pforret/notes]

    -l|--log_dir > : [option] folder for log files   [default: /Users/pforret/log/note]

    -e|--extension >: [option] extension for note files  [default: md]

    -t|--editor >  : [option] text editor to use  [default: vi]

    -p|--prefix >  : [option] data to enter before the note

    -z|--postfix > : [option] data to enter after the note  [default: pforret@Mac-mini.forret]

             : [parameter] action to perform: add/edit/find/list/paste/show/check

              : [parameter] text to add/search (optional)

### TIPS & EXAMPLES

* use note add XYZ to add one line/thought to your note file

  note add "line of text"

* use note find XYZ to find a word/phrase in your note files

  note find "DEVL"

* use note edit to open your current note file in your default editor

  note edit

* use note list to show a list of all your note files with some stats

  note list

* use note show to show today's note file

  note show

* use note paste to paste the clipboard into your note file

  note paste

* use note check to check if this script is ready to execute and what values the options/flags are

  note check

```      

## Installation

with [basher](https://github.com/basherpm/basher)

```bash

basher install pforret/note

```

or with `git`

```bash

$ git clone https://github.com/pforret/note.git

$ cd note

$ sudo ln -s $(pwd)/note /usr/local/bin/ # or somewhere else in your path

```

## Acknowledgements

* script created with [bashew](https://github.com/pforret/bashew)

© 2020 Peter Forret