Skip to content

A minimal, interactive CLI note-taking tool with full CRUD support for managing notes directly from the terminal.

License

Notifications You must be signed in to change notification settings

Gazi2050/notely-cli

Repository files navigation

Notely-cli

A minimal, interactive note-taking tool for the terminal.

Install

npm install --global notely-cli

Requirements: Node.js ≥ 16

Usage

notely-cli [flag] [id]
Flag Shorthand Description
--create -c Create a new note
--read -r List all notes
--read <id> -r <id> Read a specific note
--update -u Update a note
--delete <id> -d <id> Delete a note by ID
--delete all -d all Delete all notes

Examples

Create a note

notely-cli --create
notely-cli -c

List all notes

notely-cli --read
notely-cli -r

Read a specific note

notely-cli --read fc4c754d4
notely-cli -r fc4c754d4

Update a note

notely-cli --update
notely-cli -u

Delete a note

notely-cli --delete fc4c754d4
notely-cli -d fc4c754d4

Delete all notes

notely-cli --delete all
notely-cli -d all

Notes

  • Notes are stored locally in db.json in the working directory.
  • Title limit: 50 characters
  • Content limit: 300 characters

About

A minimal, interactive CLI note-taking tool with full CRUD support for managing notes directly from the terminal.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published