Today I Learned

TIL (Today I Learned) is a command-line application for tracking what you learned today.

The intended audience is software developers. In that vein, it provides a git-like interface for adding entries, and the option of syncing them with version control or external sources (e.g., Notion).

• Today I Learned
  • Features
  • Interface
  • Prerequisites
  • Installation
  • Usage
    • Initialize a repository
    • Add files
    • Commit an entry
    • Status
    • Amend a commit
    • Push to Notion
    • View the log
  • License

Features

• Append new entries daily with a familiar, git-like interface
• Provide file attachments to your entries (e.g., code snippets, images)
• Sync data to an external source; GitHub at minimum is highly recommended, and you may also do Notion

Interface

• til init, initialize a new TIL repository or sync with an existing one
• til add <files>, stage files for the current log entry
• til commit -m "<message>", add a new log entry (message is required, files are optional; more than one commit is allowed per day)
• til status, see what is staged and what commits are outstanding
• til commit --amend, amend the previous commit
• til push, submit all outstanding commits to external sources
• til log -n <number>, view a one-line log of past learnings (with filenames)

The interface is intentionally limited. Want to edit a previous entry? You can't. Though you're welcome to edit the synced entry (e.g., the listing in Notion), and your updates will never be overwritten.

The goal is to have your til log be effectively write-on-the-day-of only, whereas your "published" version can be tidied up.

Prerequisites

• Create an empty repository on GitHub or similar
• (optionally) create a Notion database with a schema of TIL (title) and Attachments (files)

Installation

go install github.com/michaelfromorg/tiled@latest

Or build from source:

git clone https://github.com/michaelfromorg/tiled.git
cd til
go build

Usage

Here's a walk-through of all the available commands.

Initialize a repository

til init

This step requires a remote URL to a repository.

This will prompt you to configure Notion sync. If you enable Notion sync, you'll need to provide your Notion API key and database ID.

Add files

til add file1.txt file2.txt

This stages the files for the next commit.

See what's staged, or what commits are outstanding.

Commit an entry

til commit -m "Learned about Go interfaces today"

Status

til status

Amend a commit

til commit --amend -m "Learned about Go interfaces and embedding today"

Push to Notion

til push

View the log

til log
til log -n 5  # Show only the last 5 entries

License

MIT