bjourn

Crates.iobjourn
lib.rsbjourn
version0.2.3
created_at2025-01-03 14:22:48.843219+00
updated_at2025-01-12 17:25:48.801814+00
descriptionA simple command line bullet list tool
homepagehttps://bjourn.com
repositoryhttps://github.com/mikevalstar/bjourn
max_upload_size
id1502457
size53,677
Mike Valstar (mikevalstar)

documentation

README

bjourn

A commnd line Bullet List tool

Installation

cargo install --locked bjourn

Usage

A simple journaling tool

USAGE:
        bjourn [action] [args]

ACTIONS:
        -a, --add, add [text]
                Add a new entry with the given text
        -h, --help, help
                Print this help message
        -l, --list, list [optional date]
                List all entries for the given date, defaults to today
        -r, --remove, remove [id]
                Remove the entry with the given id
        -v, --version, version
                Print the version of bjourn

OPTIONS:
        -o, --output [md, markdown, json]

Actions

Add

Add a new bullet point to the list

bjourn add This is a new bullet point

Help

Print the help message

bjourn help

List

You can view the day's bullet points by specifying the day or view today's bullet points without specifying a day.

bjourn
bjourn list 2025-01-01

When piping to another command, the output is formatted as a simple list of bullet points

bjourn list 2025-01-01 | pbcopy

bjourn list | cat
* woke up and had breakfast
* added version 0.2.1 of bjourn

Remove

Remove a bullet point by specifying the id

bjourn remove beWLHOFj

Options

Output

You can specify the output format of the list command by using the -o or --output flag

bjourn list 2025-01-04 -o json

ENV variables

DEBUG - Set to true to print debug messages BJOURN_USAGE - Set to false to print the "usage" message when running bjourn with no arguments

Development Notes

Run:

cargo run

Run with arguments:

cargo run -- add This is a new bullet point

Debug Mode

DEBUG=true cargo run

Installation (Local)

cargo install --path .
Commit count: 22

cargo fmt