Documentation

Complete guide to using and developing Runtime Consider a desktop application for recording reality, not planning your day.

Installation

Runtime Consider can be installed in two ways: as a pre-built application or from source code for development purposes.

Install Pre-built Application

The easiest way to get started is to download the latest release:

# Download from GitHub Releases
# Visit: https://github.com/Peakk2011/Runtime-Consider/releases

After downloading, simply extract and run the application. No additional setup required.

Install from Source

For developers who want to modify or contribute to the project:

# Clone the repository
git clone https://github.com/Peakk2011/Runtime-Consider.git
cd Runtime-Consider

# Install dependencies
npm install

# Start development server
npm start

Quick Start

Getting started with Runtime Consider takes less than 60 seconds:

1. Open the application - Launch Runtime Consider from your applications folder
2. Write what happened today - Type your daily entry in the text area
3. Commit - Click the commit button to permanently save your entry

Core Concepts

Understanding these principles will help you use Runtime Consider as intended:

Immutability

Every entry is write-once. Think of it like a Git commit - once written, it becomes part of the permanent record. This enforces honesty and prevents revision of history.

Local-First

All data is stored locally on your machine. No cloud sync. No external dependencies. Your data lives in a simple JSON file that you can backup, version control, or move as needed.

Append-Only

The data model is append-only. New entries are added to the end of the log. Nothing is ever modified or removed from the history.

Truth Over Productivity

This app doesn't try to motivate you. It doesn't gamify your habits. It simply records what happened. Empty days are not failures - they're just part of the record.

Daily Workflow

A typical day with Runtime Consider looks like this:

Morning (Optional)

Some users open the app in the morning to see yesterday's entry. This is optional - the app doesn't enforce any particular routine.

Evening

At the end of your day (whenever that is for you):

1. Open Runtime Consider
2. Write what actually happened today - not what you wish happened
3. Review your entry
4. Commit (this is irreversible)
5. Close the app

Viewing History

You can view your complete history at any time. The history view shows:

• All past entries in chronological order
• The date each entry was committed
• The full text of each entry

Navigate through history using the arrow keys or scroll naturally through the list.

Data Structure

Runtime Consider stores data in a simple JSON format:

{
  "entries": [
    {
      "date": "2026-01-24",
      "timestamp": "2026-01-24T22:30:00Z",
      "content": "Started building Runtime Consider...",
      "committed": true
    },
    {
      "date": "2026-01-25",
      "timestamp": "2026-01-25T21:45:00Z",
      "content": "Refined the philosophy and design...",
      "committed": true
    }
  ],
  "version": "1.0.0"
}

The data file is stored in your user data directory:

• Windows: %APPDATA%/runtime-consider/data.json
• macOS: ~/Library/Application Support/runtime-consider/data.json
• Linux: ~/.config/runtime-consider/data.json

Architecture

Runtime Consider is built with:

• Electron - Cross-platform desktop framework
• TypeScript - Type-safe JavaScript
• Node.js - File system operations

Design Principles

The architecture follows these principles:

• Simplicity - No unnecessary abstractions
• Local-first - All operations happen on the local machine
• Immutability - Data structures are append-only
• Minimal dependencies - Few external packages

Building from Source

To build Runtime Consider from source code:

# Install dependencies
npm install

# Run in development mode
npm start

# Package the application
npm run package

# Create distributable builds for your platform
npm run make

Build Outputs

The npm run make command will create platform-specific distributables:

• Windows: .exe installer
• macOS: .dmg installer
• Linux: .deb and .rpm packages

Contributing

Contributions are welcome, but please understand the philosophy first. The goal is not to add features - it's to maintain clarity.

What to Contribute

• Bug fixes
• Performance improvements
• Documentation improvements
• Platform compatibility fixes

What Not to Contribute

• Cloud sync features
• Gamification or streaks
• Editing past entries
• Reminders or notifications
• Social features

API Reference

While Runtime Consider doesn't expose a public API, developers can interact with the data file directly.

Data File Format

The JSON structure is intentionally simple and self-documenting. See the Data Structure section for details.

Keyboard Shortcuts

Runtime Consider supports these keyboard shortcuts:

• Ctrl/Cmd + Enter - Commit entry
• Ctrl/Cmd + H - View history
• Escape - Close history view
• Ctrl/Cmd + Q - Quit application

Troubleshooting

Application won't start

Ensure you have the required permissions to run the application. On macOS, you may need to allow the app in System Preferences → Security & Privacy.

Data file not found

The application creates the data file on first run. If it's missing, check the data directory locations for your platform.

Entry won't commit

Entries must contain text to be committed. Empty entries are not allowed.