Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 3.13 KB

README.md

File metadata and controls

90 lines (57 loc) · 3.13 KB
Raw

Journey2

Journey2 is a simple CLI tool for maintaining a text-based journal. This Rust project provides you with the ability to initialize your journal, create new entries, and open created entries. Entries are stored as text files, which should make access and compatibility easy.

Installation

Download from Releases

There are precompiled binaries for Linux+GNU, FreeBSD, and macOS in the Releases page. (Note that I haven't tested the ARM binaries for macOS. [I don't have an ARM MacBook ☹️]). If you don't see your computer's configuration, you can build from source.

Building from source

Make sure you have Rust and Cargo installed on your system. You can install them by following the instructions on the Rust website.

Once Rust and Cargo are installed, you can clone the stable branch of this repository and build the journey2 executable by running the following commands:

git clone --branch stable --single-branch https://github.com/noahdominic/journey2.git
cd journey2
cargo build --release

The compiled executable will be located at target/release/journey2.

Usage

Initializing the Journal

Before using the journal, you need to initialize it by running the init command. This command sets up the necessary directory structure for storing your journal entries, and stores information needed for generating new journal entry preambles.

journey2 init

Creating a New Journal Entry

To create a new journal entry, use the new command. This command allows you to add a preamble for your entry, which will be written to today's entry file. The tool will then open the text editor you set up during initialisation for you to complete the entry.

journey2 new

For reference, here is an example of an entry's preamble:

DATE: Tue, 2023 Aug 22 23:26:41 PST (+08:00)
LOCATION: University of the Philippines Cebu, Lahug, Cebu City

Temperature: 26 C, feels like 31.7 C, Overcast skies.
UV Index: 8.8  Sunrise: 05:35   Sunset: 17:59
Rain: 0 mm
Winds: 7.6 km/h SSW
Pressure: 1010.3 hPa
Humidity: 91%
Visibility: 11.32 km

Opening Today's Journal Entry

To open today's journal entry, use the open command. This allows you to add or modify the content of the entry.

journey2 open

Getting Help

If you need assistance with the available commands, you can use the help command to display information about how to use the tool.

journey2 help

or

journey2 -h

Storage

Journal entries are stored as text files within the same directory as the config.toml that is created during the initialisation process. Journal entries are stored within the directory structure in the format year/month/day. For example, an entry for 14th March 2023, would be stored at ./2023/03/14.

Licence

This project is licensed under the European Union Public Licence version 1.2 (EUPL-1.2). You can find the full text of the EUPL-1.2 licence in the LICENCE file.

Happy journalling! If you have any questions or need further assistance, don't hesitate to reach out.