https://github.com/wakatime/obsidian-wakatime

Obsidian.md plugin for automatic time tracking and metrics generated from your Obsidian usage activity.
https://github.com/wakatime/obsidian-wakatime

obsidian-plugin time-tracker time-tracking

Last synced: 2 months ago
JSON representation

Obsidian.md plugin for automatic time tracking and metrics generated from your Obsidian usage activity.

• Host: GitHub
• URL: https://github.com/wakatime/obsidian-wakatime
• Owner: wakatime
• License: bsd-3-clause
• Fork: true (obsidianmd/obsidian-sample-plugin)
• Created: 2022-12-16T08:15:35.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-07T22:04:26.000Z (7 months ago)
• Last Synced: 2024-08-08T00:44:45.964Z (6 months ago)
• Topics: obsidian-plugin, time-tracker, time-tracking
• Language: TypeScript
• Homepage: https://wakatime.com/obsidian
• Size: 66.4 KB
• Stars: 57
• Watchers: 2
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - wakatime/obsidian-wakatime - Obsidian.md plugin for automatic time tracking and metrics generated from your Obsidian usage activity. (TypeScript)
• jimsghstars - wakatime/obsidian-wakatime - Obsidian.md plugin for automatic time tracking and metrics generated from your Obsidian usage activity. (TypeScript)

README

        
# WakaTime for Obsidian

[WakaTime][wakatime] is an open source Obsidian plugin for metrics, insights, and time tracking automatically generated from your Obsidian usage activity.

## Installation

1. Inside Obsidian, click `Settings` → `Community Plugins` → `Browse`.

2. Search for `wakatime`, click on the WakaTime plugin.

3. Click the `Install` button.

4. Click the `Enable` button.

5. Enter your [api key][api key], then press `enter`.

6. Use Obsidian and your activity will be displayed on your [WakaTime dashboard](https://wakatime.com)

## Usage

Visit [https://wakatime.com](https://wakatime.com) to see your coding activity.

![Project Overview](https://wakatime.com/static/img/ScreenShots/Screen-Shot-2016-03-21.png)

To edit your api key, open the `Command Palette` then type `WakaTime` and select the `WakaTime API Key` command.

## Troubleshooting

The [How to Debug Plugins][how to debug] guide shows how to check when coding activity was last received from your editor using the [Plugins Status Page][plugins status page].

For more general troubleshooting info, see the [wakatime-cli Troubleshooting Section][wakatime-cli help].

## Contributing

- Clone this repo.

- `npm i` or `yarn` to install dependencies

- `npm run dev` to start compilation in watch mode.

## Manually installing the plugin

- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.

[wakatime]: https://wakatime.com/vs-code

[api key]: https://wakatime.com/api-key

[wakatime-cli help]: https://github.com/wakatime/wakatime-cli/blob/develop/TROUBLESHOOTING.md

[how to debug]: https://wakatime.com/faq#debug-plugins

[plugins status page]: https://wakatime.com/plugin-status