📒 Note CLI

A fast, lightweight CLI notes app that lives in your terminal. Notes are saved per project with no global mess, no switching apps. Just type and go.

Why Note CLI?

You're deep in coding and suddenly think "I need to fix that bug later". Instead of switching to Notion, Notes or your phone, just type:

note add "fix that bug"

Done. Back to coding in 2 seconds. Notes are saved inside your current project folder so each project has its own isolated list.

Install

npm install -g @azharzisan/note-cli

[!IMPORTANT] The Note CLI will not work if Global command -g is not added. So make sure to add -g after typing npm install.

Commands

Add a note

note add "your note here"

Add a note with tag

note add "refactor header component" --tag react

List all notes

note list
note list --tag react

Search notes

note find "keyword"

Delete a note

note rm "id"

Clear all notes

note clear

Example

$ note add "fix the auth bug"
✔  Note added → "fix the auth bug"

$ note add "refactor Header component" --tag react
✔  Note added → "refactor Header component"

$ note list
┌───────┬──────────────────────────────┬────────┬──────────────────┐
│ ID    │ Note                         │ Tag    │ Added            │
├───────┼──────────────────────────────┼────────┼──────────────────┤
│ V1StG │ fix the auth bug             │ -      │ Jun 5, 10:32 AM  │
│ X9kLm │ refactor Header component    │ react  │ Jun 5, 10:33 AM  │
└───────┴──────────────────────────────┴────────┴──────────────────┘

$ note find "auth"
┌───────┬──────────────────────────────┬────────┬──────────────────┐
│ ID    │ Note                         │ Tag    │ Added            │
├───────┼──────────────────────────────┼────────┼──────────────────┤
│ V1StG │ fix the auth bug             │ -      │ Jun 5, 10:32 AM  │
└───────┴──────────────────────────────┴────────┴──────────────────┘

$ note rm "V1StG"
✔  Note "V1StG" is sucessfully deleted

$ note clear
? Are you sure you want to delete all 1 notes? (y/N) y
✔  All notes cleared

How it works

Notes are saved in a notes.json file inside your current working directory. The folder you ran the command from. This means:

flowr/
├── src/
├── notes.json     ← flowr's notes only
└── package.json

invoice-app/
├── src/
├── notes.json     ← invoice app's notes only
└── package.json

Add notes.json to your .gitignore so your personal notes don't get pushed to GitHub:

# .gitignore
notes.json

Dependencies

| Package | Purpose | |---|---| | commander | Parses CLI commands and flags | | chalk | Terminal colors | | cli-table3 | Renders the notes table | | inquirer | Confirmation prompt for note clear | | nanoid | Generates unique note IDs |

Author

Made by @azharzisan

License

ISC

Contributing

This project is personal and not open for contributions. Feel free to fork it and build your own version.