README file from
GithubFocus Timer Plugin - User Guide
A local focus timer plugin designed for Obsidian, with support for statistical analysis, card view, and embedding data display in notes.
Quick Start
Open the timer: Click the left sidebar icon / bottom status bar / command palette Open Focus Timer View
Start focusing:
- Enter a task name (optional, up to 40 characters)
- Choose mode: Countdown (default 25 minutes) or Stopwatch
- Use +/- buttons to adjust or click the time to set focus duration
- Click "Start" or press Enter (if keyboard shortcuts are enabled)
End a session:
- Complete: Mark as completed and save the record
- Abandon: Mark as abandoned and save the record
- When countdown ends, you can start a break period
Timer Modes
| Mode | Description | Features |
|---|---|---|
| Countdown | Count down from a set duration | Can auto-switch to stopwatch / start break period |
| Stopwatch | Count up from zero | No preset duration, can pause/resume |
Commands
Access via command palette (Cmd/Ctrl + P):
Start Focus (25m/50m)- Quick start the timerStop Focus (Complete)- Complete current sessionAbandon Focus- Abandon current sessionOpen Focus Timer View- Open timer panelStart Quick Timer 1/2/3- Start preset quick timer 1/2/3
Statistics and Views
Focus history: Card-style layout to view all sessions, filterable by date Statistics: Today's focus duration / completed task count / 7-day average / monthly average / yearly total Charts: Visualize focus data (7/14/30 days, this month, this year), supports both duration and task count metrics
Embed in Notes
Use code blocks to embed focus timer data and charts in notes.
Basic Syntax
```focus
```
Displays today's focus statistics and the default statistics chart.
```focus
date: today
```
Displays today's focus statistics and today's focus items list.
Configuration Parameters
| Parameter | Description | Optional Values |
|---|---|---|
date |
Specify date | today, yesterday, 2026-01-20 (specific date) |
chart |
Chart display range (when no date parameter) | 7, 14, 30, month, year, none |
chart |
Chart display range + metric (when no date parameter) | 30 time, 30 task (first parameter selects from the options above, second parameter chooses between time and task; if omitted, both focus time and completed task count are shown) |
record |
Hide records (applies with or without date parameter) | none (default: shown when not specified) |
items |
Hide focus items list (when date parameter is used) | none (default: shown when not specified) |
height |
Custom height in pixels (applies with or without date parameter) | 300, 500 ... |
Examples
```focus
chart: 7 task
height: 500
```
Displays today's focus statistics and 7-day completed task count chart, with display box height limited to 500px.
```focus
date: 2026-01-01
items: none
height: 400
```
Displays that day's statistics and limits the display box height to 400px.
Tips
- Task suggestions: The plugin remembers recent tasks and suggests them when typing
- Quick access: Use sidebar icon, status bar, or keyboard shortcuts
- Quick timers: Set commonly used timers as quick timer 1/2/3
- Pomodoro: Enable auto-break feature
- Embed anywhere: Add focus code blocks in journals, project pages, or review documents
Support
- Help: https://tianyezhou.com/focus-timer
- Author: Tianye Zhou (https://tianyezhou.com)
Note: This plugin supports desktop only and requires Obsidian 1.4.5 or higher.