TTrack

A minimalist command-line time tracker with weekly goals. Track your time spent on various activities and monitor progress toward your weekly targets.

Features

• Interactive terminal user interface (TUI)
• Simple and clean design
• Built with TypeScript and Ink

Prerequisites

• Node.js 18 or higher

Installation

From npm (Recommended)

Install TTrack globally via npm:

npm install -g ttrack

Once installed, you can run TTrack from anywhere:

ttrack

From Source (Development)

Clone the repository and install dependencies:

git clone <repository-url>
cd ttrack
pnpm install

Testing Local Changes

To test the package locally before publishing:

# Build the project
pnpm run build

# Link the package globally
npm link

# Now you can run ttrack from anywhere
ttrack

# When done testing, unlink
npm unlink -g ttrack

Configuration

TTrack supports optional configuration to customize where your database file is stored.

Database Location

By default, TTrack stores its database (ttrack.sqlite) in the current working directory. To specify a custom location, create a configuration file:

1. Create the configuration directory:

   mkdir -p ~/.ttrack

2. Create the config file at ~/.ttrack/config.json:

   {
     "databaseFileLocation": "/path/to/your/ttrack.sqlite"
   }

3. Replace /path/to/your/ttrack.sqlite with your desired database location.

If the config file doesn't exist or the databaseFileLocation key is not set, TTrack will use the default location (current directory).

Development

Run the application locally in development mode:

pnpm run dev

This will start the TTrack TUI where you can:

• Navigate the menu using arrow keys (↑/↓)
• Select options with Enter
• Quick quit with 'q' key

Building

To build the TypeScript code:

pnpm run build

To run the built version:

pnpm start

Type Checking

Run TypeScript type checking:

pnpm typecheck

Project Structure

ttrack/
├── src/
│   ├── cli/           # CLI entry point
│   │   └── index.tsx
│   └── ui/            # UI components
│       ├── App.tsx    # Main application component
│       └── components/
│           └── Banner.tsx
├── package.json
└── tsconfig.json

License

MIT License - See LICENSE file for details