https://github.com/spy16/connote
📝 connote is a dead-simple console-based note taking tool.
https://github.com/spy16/connote
console-application journal note todoapp
Last synced: 5 months ago
JSON representation
📝 connote is a dead-simple console-based note taking tool.
- Host: GitHub
- URL: https://github.com/spy16/connote
- Owner: spy16
- License: gpl-3.0
- Created: 2022-02-12T06:35:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-03T09:57:50.000Z (about 3 years ago)
- Last Synced: 2025-01-01T13:13:46.917Z (6 months ago)
- Topics: console-application, journal, note, todoapp
- Language: Go
- Homepage:
- Size: 136 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📝 connote
 [](https://goreportcard.com/report/github.com/spy16/connote)
connote is a simple console-based note taking tool.
## Features
* Simple markdown based notes.
* All notes are stored as files in `$HOME/.connote/`.
* Front-matter is used for tags and other metadata.
* Multiple profiles support for isolating notes.
* All commands support `json`, `yaml`, `pretty` outputs.
## Install
* Download the binary for your operating system from [Releases](https://github.com/spy16/connote/releases)
* OR, Run `go install github.com/spy16/connote` to directly build and install.
## Usage
```shell
# write down anything specific to the day (e.g., work log)
$ connote edit
# edit yesterday's note
$ connote edit @yday
# create a custom note with tags
$ connote edit kafka -t tldr
# show today's note
$ connote show
# show last week's note
$ connote show @-7
# show note on kafka
$ connote show kafka
# list all notes (table view)
$ connote ls
# list all notes (yaml format)
$ connote ls -o yaml
# list all tldr type notes
$ connote ls -i tldr
```
* *💡 Tip*: Alias `connote` as `cn` for easy access.
* *📌 Note*: Connote uses the editor command set through `EDITOR` environment variable (The editor must be blocking, like Vim).