https://github.com/ifennna/notes

Jot notes from your terminal
https://github.com/ifennna/notes

go notes notes-app terminal

Last synced: 6 months ago
JSON representation

Jot notes from your terminal

• Host: GitHub
• URL: https://github.com/ifennna/notes
• Owner: ifennna
• License: mit
• Created: 2018-09-15T09:27:08.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-28T08:20:05.000Z (over 3 years ago)
• Last Synced: 2025-04-06T20:23:47.228Z (about 1 year ago)
• Topics: go, notes, notes-app, terminal
• Language: Go
• Homepage:
• Size: 67.4 KB
• Stars: 18
• Watchers: 3
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# notes

A command line note taking app built with Go

[![asciicast](https://asciinema.org/a/JMZxtuxEPfrbFrOmj7uaobqKt.svg)](https://asciinema.org/a/JMZxtuxEPfrbFrOmj7uaobqKt)

## Installation

To build, make sure you have [Go](https://golang.org/dl/) installed. Run `go build` to 

create a binary or `go install` to add it to your GOPATH.

## Usage

  notes [command]

  

Available Commands:

  - `add`: Add notes

    - `notes add [notebook] "my 1st note" "my 2nd note" ..`

    - if `notebook` name is not supplied, it is added to `Default` notebook

    - if `notebook` doesn't exist, new notebook is created

  - `help`: Help about any command

    - `notes help`

  - `ls`: List stuff

    - `notes ls [notebook]`

    - if `notebook` name is not supplied, names of notebooks are displayed

    - if `notebook` name is supplied

      - if notebook by given name exists, all notes of that notebook are displayed along with their `note_id`s

      - if notebook by given name doesn't exist, only the entered notebook name is shown in output (needs to be improved)

  - `lsa`: List stuff

    - `notes lsa`

    - names of notebooks are displayed and notes in each notebook are displayed as a tree

  - `del`: Delete notes

    - `notes del notebook note_id_1 note_id_2 ..`

    - if notebook by given name exists

      - if note by given note_id exists, it is deleted; and note deletion message is displayed

      - if note by given note_id doesn't exist, nothing happens. Note deleteion message still appears (needs to be fixed)

    - if notebook by given name doesn't exist

      - command terminates unexpectedly with stacktrace (needs to be fixed)

  - `rm`: Removes a notebook

    - `notes rm notebook`

    - if `notebook` doesn't exist, nothing changes

Use "notes [command] --help" for more information about a command.