{"id":19568555,"url":"https://github.com/michaellee/ntbk","last_synced_at":"2025-04-27T02:33:02.924Z","repository":{"id":65369964,"uuid":"58644220","full_name":"michaellee/ntbk","owner":"michaellee","description":":green_book: A simple command-line journaling tool written in Node.js","archived":false,"fork":false,"pushed_at":"2019-10-13T03:00:45.000Z","size":98,"stargazers_count":26,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-14T08:05:43.724Z","etag":null,"topics":["command-line","javascript","nodejs","notebook"],"latest_commit_sha":null,"homepage":"https://michaelsoolee.com/ntbk-journal/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/michaellee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-05-12T13:31:14.000Z","updated_at":"2023-06-28T14:44:21.000Z","dependencies_parsed_at":"2023-01-19T23:16:26.828Z","dependency_job_id":null,"html_url":"https://github.com/michaellee/ntbk","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaellee%2Fntbk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaellee%2Fntbk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaellee%2Fntbk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaellee%2Fntbk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaellee","download_url":"https://codeload.github.com/michaellee/ntbk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251080744,"owners_count":21533142,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","javascript","nodejs","notebook"],"created_at":"2024-11-11T06:05:21.887Z","updated_at":"2025-04-27T02:33:02.527Z","avatar_url":"https://github.com/michaellee.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# :green_book: ntbk\n\n*ntbk* is a simple command-line journaling tool written in Node.js.\n\n## Installation\n\nTo install *ntbk* using npm:\n\n```\nnpm install -g ntbk\n```\n\n## Usage\n\nType `ntbk` into your shell window followed by a message:\n\n```\n\u003e ntbk 11-month-old stood up today for the first time\n```\n\nthen hit enter to have the entry added to your designated notebook.\n\nAlternatively, you can type `ntbk` and hit return and then type your message. When you're ready to save your entry, hit return again.\n\n### Options\n\n#### -l, --list [n]\n\nYou can see all your entries by using the `--list` option:\n\n```\n\u003e ntbk --list\n```\n\nYou can also pass a number to the `--list` option and it will return a subset of your entries. For example if you passed 2 it will return the last two *ntbk* entries.\n\n```\n\u003e ntbk -l 2\n```\n\nThe above uses the shorthand version `-l` of the `--list` option.\n\n#### -t, --tag \\[tag\\]\n\nAs you write entries in *ntbk* you might want to group similar entries together. You can do this by using *tags*.\n\n*ntbk* supports Twitter like hashtag syntax.\n\n```\nI really think pizza is the best! #food\n```\n\nThe syntax is a word that describes your entry with a hash (#) symbol prepended. Tags can be used anywhere within your entry.\n\nWhen using tags while writing your entry, you might have to escape them using the backslash (\\\\) character.\n\n```\n\u003e ntbk Implemented tags in ntbk today \\#dev\n```\n\nTo list all *ntbk* entries containing a tag, you can use the `--tag` option:\n\n```\n\u003e ntbk --tag food\n```\n\nAs you can see in the example above, the tag option doesn't need to have the hashtag symbol prefixed when passing it a parameter.\n\nYou can also get a list of all existing tags in your notebook. Simply use the `--tag` option without passing in a tag as a parameter:\n\n```\n\u003e ntbk --tag\n```\n\nThe shorthand version of `--tag` is `-t`.\n\n#### -m, --moments \\[value\\_unit\\]\n\nLike a time machine, the `--moments` option allows you to relive your past entries from a year go.\n\n```\n\u003e ntbk --moments\n```\n\nIf you didn't write any entries a year ago from your current day, no problem, *ntbk* will retrieve a random moment from your entries.\n\nThe `--moments` option also allows you to pass in several time units to retrieve moments in time.\n\nLet's say instead of a year, I wanted to relive my moments from last month, I could do this:\n\n```\n\u003e ntbk --moments 1m\n```\n\nAs you can see the syntax goes, numerical value paired with a single character unit. The units of time that `--moments` recognizes are:\n\n```\nd - day\nm - month\ny - year\n```\n\nThe shorthand version of `--moments` is `-m`.\n\n#### --count, -c \\[emojify\\]\n\nSee how many entries you've got in your notebook with `--count`.\n\n```\n\u003e ntbk --count\n```\n\n## Changelog\n\n### v0.5.3 / 2017-07-18\n\nAdded information on how to hack on *ntbk* from local machine.\n\n### v0.5.2 / 2016-06-29\n\nThe `--tag` option can now [list existing tags](https://github.com/michaellee/ntbk/tree/develop#-t---tag-tag) from your journal. Run `ntbk --tag` without passing a tag and it'll list all your tags.\n\n### v0.5.1 / 2016-06-28\n\nFixed a bug with `--moments` where the default entry is a year from today.\n\n### v0.5.0 / 2016-06-23\n\nSee how many entries you've captured in your notebook with `--count`.\n\n[See all releases](https://github.com/michaellee/ntbk/releases)\n\n## Credit\n\n*ntbk* was inspired by the Python journaling app, [jrnl](https://github.com/maebert/jrnl).\n\n## Make it better\n\nHelp make *ntbk* better. If you're handy with some JavaScript and/or Node.js, feel free to create a pull-request. You could also [create a new issue](https://github.com/michaellee/ntbk/issues/new) on GitHub. If you have any questions feel free to shoot me a tweet [@michaelsoolee](https://twitter.com/michaelsoolee).\n\nTo hack on *ntbk* on your local machine, first clone the repo, then from within your local copy, type `npm link`. This will make a symlink to your local copy.\n\n## License\n\n[MIT](https://github.com/michaellee/ntbk/blob/master/LICENSE) \u0026copy; [Michael Lee](https://michaelsoolee.com)\n\n[newsletter]: http://eepurl.com/b67A_1\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaellee%2Fntbk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaellee%2Fntbk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaellee%2Fntbk/lists"}