https://github.com/donuts-are-good/notes

A simple CLI note-taking tool for humans
https://github.com/donuts-are-good/notes

cli donut-utils go golang journaling notes tagging tags

Last synced: 5 months ago
JSON representation

A simple CLI note-taking tool for humans

• Host: GitHub
• URL: https://github.com/donuts-are-good/notes
• Owner: donuts-are-good
• Created: 2022-12-31T04:59:12.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-13T03:06:21.000Z (almost 2 years ago)
• Last Synced: 2025-10-08T18:18:36.554Z (9 months ago)
• Topics: cli, donut-utils, go, golang, journaling, notes, tagging, tags
• Language: Go
• Homepage:
• Size: 14.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
![banner](https://github.com/user-attachments/assets/64eff8ee-27a5-49f4-a173-0f08b0abe551)

![donuts-are-good's followers](https://img.shields.io/github/followers/donuts-are-good?&color=555&style=for-the-badge&label=followers) ![donuts-are-good's stars](https://img.shields.io/github/stars/donuts-are-good?affiliations=OWNER%2CCOLLABORATOR&color=555&style=for-the-badge) ![donuts-are-good's visitors](https://komarev.com/ghpvc/?username=donuts-are-good&color=555555&style=for-the-badge&label=visitors)

# 📝 Notes

Notes is a simple tag-based note-taking app for the command line.

## ✨ Features

- Create notes with titles, bodies, and tags

- List all notes

- List notes by specific tag

- List all tags

- Search notes by tag

- Open notes in your default text editor

## 🚀 Usage

Notes uses subcommands for different operations:

1. Create a note:

```bash

notes create -title "Note Title" -body "Note content" -tags "tag1,tag2"

```

2. List all notes:

```bash

notes list

```

3. List notes by tag:

```bash

notes list -tag "tagname"

```

4. List all tags:

```

notes tags

```

5. Search notes by tag:

```bash

notes tags -search "tagname"

```

## 🏴‍☠️ Flags

### Creating a note

- `-title`: The title of the note (required)

- `-body`: The content of the note

- `-tags`: A comma-separated list of tags for the note

Example:

```bash

notes create -title "Meeting Notes" -body "Discussed project timeline" -tags "work,project"

```

### Listing notes

- `-tag`: List entries for a specific tag

Example:

```bash

notes list -tag "work"

```

### Managing tags

- `-search`: Search entries by tag

Example:

```bash

notes tags -search "project"

```

## 📜 License

Notes is licensed under the [MIT](https://opensource.org/licenses/MIT) software license.