https://github.com/hellerve/notes

A dead simple note-taking utility
https://github.com/hellerve/notes

Last synced: about 1 year ago
JSON representation

A dead simple note-taking utility

• Host: GitHub
• URL: https://github.com/hellerve/notes
• Owner: hellerve
• License: unlicense
• Created: 2018-01-07T19:26:10.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-01-21T19:17:33.000Z (about 8 years ago)
• Last Synced: 2025-02-28T07:54:59.977Z (about 1 year ago)
• Language: Python
• Size: 8.79 KB
• Stars: 6
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# notes

A simple note-taking utility, inspired by [this beautiful article by Peter

Lyons](https://peterlyons.com/leveling-up#your-work-journal).

It will write all of your musings to a file called `~/.daily_log`. Currently

no project-specific note-taking is possible or planned.

## Installation

`notes` unpythonically chooses to be installed via `make`. The relevant command

is `make install`. It will set you up. `notes` is written in Python, and a

Python interpreter is required on your `$PATH`. Python 2 and 3 should both

work.

## Usage

`notes` has four major modes: `edit`, `show`, `search/isearch`, and `dump`.

The `edit` mode will be entered by typing `notes edit`, which will open your

favorite editor as determined by the `$EDITOR` path variable—defaulting to

`vi`, noone’s favorite editor. In it, you can write notes to your hearts

content. After you’re done, save the file and exit. The contents of that file

will be appended to the log, with an added date.

`dump` mode—the other writing mode—will be entered by typing `notes

`. It will take any arguments

supplied and dump them into your log file verbatim. This means you can use it

like so:

```bash

$ notes i restarted the server and found out it has trouble rebooting on its own

```

The prefixed date helps you localize it.

The `show` mode will just dump the file as-is. Protip: use `less` or a similar

utility to make sense of this mess.

For a full-text search of your logs using regexes, use `search` mode. It is

capable of multiline regexes as well. If you want case-insensitive matches,

use `isearch`.



Have fun!