Journal

---

📔 Preserve your memories, self-reflect and record ideas on-the-go.

📝 Table of Contents

• About
• Getting Started
• Usage
• Contributing
• Authors
• Acknowledgement

🧐 About

Journal helps you manage multiple journals with ease from the comfort of your terminal, web browser or API client. You can import/export journals as horcruxes and set simple customizations for layout, theme, and keybindings.

Journal brings out the quintessence of your potent yet pervious mind. Get personal with it and use its gorgeous powers for good.

Cli Screencast

Web Screencast

🏁 Getting Started

Check out live demo of web app.

Installing

Binary Release

You can download a binary release for Windows, Mac or Linux here.

Using Go Get

go get -u github.com/paulebose/journal

If you get an error claiming that journal command cannot be found or is not defined, you may need to add ~/go/bin to your $PATH. ~/go/bin should not be mistaken for $GOROOT/bin (which is for Go's own binaries, not installed apps like journal).

🎈 Usage

Here is some basic usage information for terminal.

Commands

Create and open a new note with the default author:

journal new

Create a new note with a custom id:

journal create note --id custom-id

Create a new author:

journal create author

Edit an author or tag:

journal edit <id>

Run journal help for more information.

journal help

Keybindings

  r refresh list
  h show help
  t toggle screen mode (normal/half/fullscreen)
  , show settings
  / search
  x select item
  Q quit
  esc close current panel

Check the keybindings docs for more information.

Configuration

Default path for config file:

• Windows: C:\Users\USERNAME\AppData\Roaming\Journal\config.yml
• MacOS: /Users/USERNAME/Library/Application Support/Journal/config.yml
• Linux: /home/USERNAME/.config/Journal/config.yml

# Example Config
cli:
    mouseEnabled: true
    editor: 'in-built'
    confirmOnQuit: false
    keybindings:
        # command: 'key'
web:
    port: 9001

Check the configuration docs for more information.

🤿 Contributing

Contributors are welcome! Please check out the contributing guide. For discussions about stuff, you can use GitHub Discussions

✍️ Authors

• @PaulEbose - Idea & initial work

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• Influence: @Richmond-Eribo