devlog

A command line logging tool for recording thoughts/ideas/issues as a software developer (or anyone else who wants to write notes from the command line)

Usage no npm install needed!

<script type="module">
  import devlog from 'https://cdn.skypack.dev/devlog';
</script>

README

devlog

A command line diary-entry tool for recording thoughts/ideas/anything from your terminal

NPM Version semantic-release Coverage Status Dependencies status Dev-dependencies status

Install

npm install -g devlog

Usage

$ devlog -?

Usage: devlog <options>

devlog           Create a log entry in the global devlog
devlog -?        This help information
devlog -l        Create a log entry in the local devlog in the current directory
devlog -m "msg"  Add "msg" to the devlog in the current directory
devlog -p        Print the log from oldest-to-newest
devlog -pr       Print the log from newest-to-oldest

Global log location: /users/dknuth/devlog/devlog.md

$ devlog
Add log entry: (press Ctrl+C when finished)
> This is my first log entry
> Just found a cool fix for when PhantomJS doesn't start...
> [Ctrl+C]
Log saved to /users/dknuth/devlog/devlog.md

Troubleshooting

The date-stamp is in the wrong format!

The current version of devlog requires Node 14+, which contains the full set of Internationalisation Components for Unicode (ICU). However, it is possible to install Node 14+ without Full ICU support. In this case, the default locale (en-US?) is used by Node, even when devlog detects the operating system's actual locale.

To fix this, ensure you install Node 14+ with full ICU support (the default build). Alternatively, you can try installing the full-icu package (which has instructions for getting it working).

Contributing

See CONTRIBUTING.md.

License

This software is licensed under the MIT Licence. See LICENSE.