Garmy
Garmy vault/Home/Garmy

Garmy

Properties
plugin id
garmidian
builds
recoverymovementtrainingraces
needs
DashyGarmin Personal API key
languages
7
mobile
not tested yet
version
1.1.2 · Obsidian 1.13.0 or later
license
MIT

Garmy builds a dashboard from your own Garmin data, inside an Obsidian note.

You paste a Garmin Personal API key. Garmy loads up to a year of history into one note per day. A four-step wizard asks which sports and metrics you want, previews the dashboard on your own numbers, and writes it into a note as Dashy blocks. The note is plain markdown: edit it, copy a block to your home page, or uninstall Garmy and keep everything. From install to the first dashboard takes about a minute.

Recovery cards in an Obsidian note: sleep score, sleep duration, HRV, Body Battery, resting heart rate and stress, then the same numbers as a 7 day average against your usual
A Garmy dashboard in Obsidian. The numbers are generated demo data, nobody's health.
A frame from the Garmy overview video: the wizard's library of dashboards
Video, 2 minutes: from the Garmin key to a finished dashboard, on my own data. Watch on YouTube.

Four parts, built from what your data holds

What is in the note

Dashy blocks: stats, dashy-chart, heatmap, progress and countdown, written as YAML you can read. Dashy draws them from properties in your daily notes. Garmy only writes the blocks and the day notes. Every dashboard names Garmin as the data source under its title.

Install.md

Install

Garmy is in Obsidian's community plugin catalog. It draws its blocks with Dashy, so install both.

  1. Settings›Community plugins›Browse
  2. Search for Garmy, then Install and Enable.
  3. Do the same for Dashy.
  4. Open the command palette (Ctrl/Cmd P) and run Garmy: Build a Garmin dashboard. The ribbon button does the same.

Garmy needs Obsidian 1.13.0 or later. You also need a Garmin Connect account and a Personal API key, which a short guide walks through.

Garmy
  • Garmy: Build a Garmin dashboardThe four-step wizard
  • Garmy: Sync the latest days from GarminRefresh the day notes now
  • Garmy: Rebuild the dashboard in this noteRegenerate only Garmy's part of the note

The command names as the plugin registers them. Also on the plugin listing.

How it works.md

How it works: key, load, choose, preview

  1. Key. In Garmin Connect open Settings, then Personal API Key. Accept the terms, create a key and pick how long it lives. Garmin shows it once. Copy it and paste it into the wizard. Garmy checks it with Garmin before moving on.
  2. Load. Pick 30 days, 90 days or one year. Garmy reads steps, heart rate and stress, sleep, HRV and workouts, about 17 requests for a year, and saves one note per day in Garmy/data. Keep the window open until it finishes.
  3. Choose. Pick a kind of dashboard from the library. Cards your data cannot fill yet are greyed out and say what they wait for. Options hold an optional races folder and the language of the labels.
  4. Preview. The wizard draws the dashboard on your own numbers. Create a note or Insert into the current note.
The first wizard step: a Personal API key field, three steps for creating the key and a picture of the Garmin Connect page
Step 1, the key.
The third wizard step: a library of dashboard kinds (Everything, Morning glance, Sleep, HRV and recovery, Steps, Run, Bike, Swim, Strength and more), Everything selected
Step 3, only what your data holds.
The last wizard step: a preview of the dashboard with recovery cards and the buttons Back, Insert into the current note and Create a note
Step 4, a preview of your own numbers.
The wizard in Obsidian: a key is pasted, a year of history loads in four parts, the user chooses what to show, previews the dashboard and creates the note, which then scrolls through recovery cards, charts, a year map by sport and monthly goals
The whole run, on demo data.

What lands in your vault is one note per day with properties only. These are example values:

Garmy/data/2026-11-06.md
---
steps: 10866
resting_hr: 49
stress: 32
body_battery: 84
sleep_score: 79
sleep_duration: "7h 5min"
hrv: 61
run_km: 10.4
run_min: 51
---

Garmy writes a property only when Garmin returns the number: steps, resting_hr, stress, body_battery (the day's highest value), sleep_score, sleep_duration, hrv, and per sport run_km, run_min, bike_km, bike_min, swim_km, swim_min, strength_min. Folders are configurable in settings.

Kilometers or miles: choose in the wizard (More options) or in settings. In miles mode the distances are run_mi, bike_mi and swim_yd, because a pool is measured in yards. Switching converts the notes already on disk and asks Garmin for nothing.

Already keep Garmin numbers in your notes?

If Garmin Health Sync or your own script writes metrics such as steps or sleep_score into daily notes, the first step can find those folders and build the dashboard from them. No key, no loading. How that works.

Dashboards it builds.md

Dashboards it builds

Garmy writes only the blocks your data supports. A block whose data is missing is left out, so a dashboard built after three days is small and a rebuild a month later is bigger.

Eleven dashboards, chosen in the wizard

The third step is a library. A card whose data is missing is greyed out and says what it waits for, so the list follows your data: lifting has no distance, a swim page counts in yards in miles mode, and a sport you never do is not offered.

DashboardWhat it shows
EverythingRecovery, movement and training in one dashboard
Morning glanceFour numbers from last night with two weeks behind each, small enough for a home page
SleepScore and duration, nights above 80, a streak of 7 hour nights, a year map
HRV and recoveryHRV, resting heart rate, Body Battery and stress against your usual
StepsDaily average, 10,000 step streaks, the month and a goal for it, a year map
Run, Bike, Swim, StrengthOne sport: this week, this month, the longest, sessions, weekly volume, a goal, and the recovery signals that fit it
TriathlonSwim, bike and run side by side, bike-then-run days, a year map by sport
Race buildDays to the start, four weeks against the four before, how your body takes it
Weekly reviewFor a weekly note: that week against your usual
Monthly reviewFor a monthly note: that month day by day
Year so farTotals, the longest effort per sport, months side by side, a year map

The kind is stored in the note, so a rebuild builds the same kind again, and a triathlon dashboard picks up a sport you start later.

Recovery

Six cards with the latest sleep score, sleep duration, HRV, Body Battery, resting heart rate and stress. Under them the 7 day averages against your usual level, with a small trend. Then two charts: sleep with Body Battery, and HRV with resting heart rate. The sleep and HRV guide has the blocks to copy.

Recovery cards: sleep score, sleep duration, HRV, Body Battery, resting heart rate, stress
Latest values.
A 7 days against usual card row and a Sleep and Body Battery line chart
The week against your usual, and a chart.

Movement

Steps per day as a 7 day average, a streak of days over 10,000 steps, a bar chart with a 10,000 goal line and a year map of daily steps shaded in bands from 7,000 to 14,000.

An HRV and resting heart rate chart, a steps card, a 10,000 step streak and daily steps as bars
Steps and the streak.
Daily steps as bars with a goal line, a year map of steps and four training cards for run, bike, swim and strength
Daily steps and a year map.

Training

Cards for run, bike, swim and strength over the last 7 days, each compared with the period before once you have 14 days of data. Weekly bars of minutes per sport, a month calendar with a dot per sport, a year map coloured by the sport you trained most that day, and monthly goals taken from your own last 28 days. The training log guide and the heatmap guide go through the blocks.

Weekly training minutes as bars per sport and a November month calendar with a dot per sport
Weekly bars and a month calendar.
A year map by sport and monthly goals for run, bike, swim and strength as progress bars
Year by sport and monthly goals.

Races

Give the wizard a folder of notes that each carry a date property and the dashboard gets a countdown to the next race. Leave the folder empty and the part is skipped.

countdown
```countdown
columns: 2
items:
  - { label: Next race, field: date, source: Races, pick: next, icon: 🏁 }
```

When each part appears

Days of dataWhat gets added
1 to 6 daysCards and a note that charts come after a week
7 days7 day averages, line and bar charts, the training month calendar
14 daysThe comparison with your usual level and a small trend, the 10,000 step streak
28 daysWeekly training bars and monthly goals
30 daysThe year map of steps
60 daysThe year map by sport

No swimming cards if you never swim: a sport counts only when some day has a non-zero value for it.

Rebuild and sync.md

Rebuild and auto sync

Sync. Garmy syncs shortly after Obsidian starts and then every 6, 12 or 24 hours. You choose in settings, or turn it off. The default is every 6 hours, and Sync now sits next to it. A sync loads the days since the last one plus a margin of three, capped at 60. The three most recent days are rewritten on every sync, because a day is not finished until it is over. Older days only get missing properties filled.

Rebuild. A dashboard built after three days is small. A month later, run Garmy: Rebuild the dashboard in this note. Garmy regenerates its own part from the notes on disk, adds the charts, year maps and goals that were not possible before, picks up a sport you started since, and leaves everything you wrote around it alone.

A dashboard built from six days of data shows a few cards and a note that charts come after a week; after the rebuild command it shows recovery cards, week over week comparisons, charts, a year map and monthly goals, and the text around it is unchanged
Six days of data, then the same note after a rebuild.

Garmy's part of the note is between two comment markers. The choices it was built with are stored in one garmy property:

Garmy/My Garmin dashboard.md
---
garmy: "1|Garmy/data|recovery,activity,training||en||"
---

%% garmy:start %%

...the generated blocks...

%% garmy:end %%

The property lists the sports you switched off. A sport that shows up in your data later is included on the next rebuild.

Languages.md

Languages

The wizard, settings and notices follow Obsidian's language and fall back to English. Settings have a Language option to pick another.

enEnglishruРусскийesEspañoldeDeutschfrFrançaisptPortuguêsja日本語

The words inside the dashboard are chosen separately in the wizard (Label language), so you can keep an English interface and a dashboard in your own language.

The first step of the wizard in English, German, French, Spanish, Portuguese, Japanese and Russian
The first wizard step in all seven languages.

Translations other than English and Russian were machine-assisted. If one reads wrong, open an issue.

Privacy and network use.md

Privacy and network use

  • The keyKept in Obsidian's secure storage. It is never written to a note, to data.json or to a log. Garmy exchanges it for a token that is valid for 24 hours and keeps the token in memory only.
  • NetworkRequests go to personal.connectapi.garmin.com and nowhere else, through Obsidian's requestUrl. First to exchange the key for a token, then to read your own data.
  • TelemetryNone. No analytics, no ads, no server of mine, no account.
  • Your dataStays in your vault. If the vault syncs (iCloud, git, Obsidian Sync), the day notes sync with it like any other note.
  • FilesGarmy creates notes in the data folder and the dashboard folder you configure, and changes only the dashboard part of a note you ask it to rebuild. It looks across the whole vault only when you click Look for those notes: it reads note properties from Obsidian's cache, opens no file and keeps nothing.
  • AttributionEvery dashboard names Garmin as the data source right under the title, as Garmin's API brand guidelines ask. Keep that line if you share a screenshot.
Read Garmin's terms

Garmin describes the Personal API as meant for individuals who want programmatic access to their own data, not for commercial applications serving multiple end users. Garmy runs on your computer with your own key. Read the terms you accept when you create a key.

Garmy is not affiliated with Garmin. Data source: Garmin. Garmin and Garmin Connect are trademarks of Garmin Ltd. or its subsidiaries. The security policy is in SECURITY.md.

Requirements.md

Requirements

  • Obsidian 1.13.0 or later.
  • The Dashy plugin, which draws the blocks. Without it the note shows only the markup, and the wizard's preview warns you and can turn Dashy on or open its page.
  • A Garmin Connect account and a Personal API key you create yourself. Where to find it.

What it leaves out

  • Training Readiness and a VO2 max number. Garmin's Personal API does not provide them.
  • distance_km. The range endpoints report walking distance only, so Garmy writes no daily distance rather than show a wrong one.
  • Interpretation. Garmy draws your numbers and does not coach you.
  • Multi-sport activities are not split into their sports.
  • Phones. The plugin is not desktop-only and uses only Obsidian's own APIs, but nobody has run it on an iPhone or Android device yet.

If your notes already carry training_readiness or distance_km, for example from another plugin, Garmy's dashboard uses them in existing-notes mode.

Questions.md

Questions

Do I need Dashy?

Yes. Garmy writes Dashy blocks, and Dashy draws them. Install it from Community plugins and enable it. The wizard's preview tells you when Dashy is missing or turned off.

Where does my key go?

Into Obsidian's secure storage, and from there to Garmin's token service when Garmy needs a token. It is never written to a note or a file. Forget key in settings removes it.

The key stopped working. What now?

A key works for the lifetime you chose when you created it. When Garmin rejects it, Garmy says so once and settings show Replace key. Create a new key in Garmin Connect and paste it in the wizard.

Does it work on my phone?

Unknown. The plugin is not desktop-only, but it has not been tested on a phone yet, so treat mobile as unverified.

Will a rebuild overwrite my text?

No. Rebuild replaces only what is between %% garmy:start %% and %% garmy:end %%. Text above, below or around it stays.

Why is there no Training Readiness or VO2 max?

Garmin's Personal API does not provide them, so there is nothing for Garmy to read.

Can it overwrite the notes Health Sync wrote?

Only if you point Garmy's data folder at them. By default Garmy writes to Garmy/data. In a folder of your own notes, older days only get missing properties filled, and the three most recent days are overwritten with Garmin's latest numbers.

Is it free?

Yes, MIT licensed, and nothing is locked behind a payment. The plugin shows no ads and no donation prompts.

How do I report a bug?

Open an issue with your Garmy and Obsidian versions. Technical details of a failed sync go to the developer console, never the key.

If Garmy is useful to you

Garmy is free and made by one developer. A star on GitHub tells others the plugin is worth a look, and a coffee is a way to say thanks.