Currently status: Known issues with sync changes from vikunja documented in #13
This unofficial plugin connects Obsidian and Vikunja. Vikunja is a todo-App and task manager that helps you to organize your life. It can be used as a self-host replacement for todoist.com. Synchronize your tasks with your Vikunja instance back and forth. It holds a lot of settings to adjust it to your workflow needs.
Do not use this plugin in team work. It is designed to work with one user only, which only works on one platform at any given time. If you make changes on both ends, obsidian will always win.
Per default, this plugin only runs on manual trigger. In settings, you can find a setting to enable automatic sync, also the interval can be set there. All tasks will be pushed to vikunja on first sync and stay in sync.
This plugin depends on some other plugins to work: (subject to change with later updates)
The experience with this plugin is a lot like the excellent plugins for todoist:
Supported Vikunja API: v0.24.1
Every feature prioritizes the Obsidian side. If a task is updated in both systems, the Obsidian task will be the one who wins. So it is currently not recommended to use Vikunja and Obsidian at the same time to update tasks or in team work.
| Feature | -> Vikunja | <- Vikunja | Description |
|---|---|---|---|
| Add task | ✅ | ✅(2) | (2) Default behaviour. But disables (3) |
| Update task | ✅ | ✅ | |
| Delete task | ✅(3) | ❌(4) | (3) Can be enabled through settings. But disables (2). (4) No way to find the deleted vikunja tasks. |
| Modify task title | ✅ | ✅ | |
| Modify task description | 🚧 | 🚧 | Issue #1 |
| Modify assigned labels/tags | ✅ | ✅ | |
| Modify due date | ✅ | ✅ | |
| Mark task as done/undone | ✅ | ✅ | |
| Sync done date | ✅ | ✅ | |
| Set and modify task priority | 🚧 | 🚧 | Issue #3 |
| Add and modify assigned project | ✅(1) | 🚧 | Issue #4 (1) Currently only default project supported. |
| Move tasks between files | ✅ | ❌ | |
| Modify relations | 🚧 | 🚧 | Issue #2 |
✅= done and usable, 🚧=not yet implemented but under development, ❌=not possible or will not come
Supported Task Formats:
Supported Vault Searching Implementations:
Your Vikunja could have a different timezone setting then you on your device. This leads to a bug, where updating always prefer one of your devices. Set the correct timezone in your Vikunja instance.
- Clone this repo.
- Make sure your NodeJS is at least v16 (
node --version). npm ioryarnto install dependencies.npm run devto start compilation in watch mode.
So you need a Java Runtime Environment (JRE). Install at least Java 11.
Then you can use npx openapi-generator-cli to rebuild the sdk for vikunja api.
npx openapi-generator-cli generate -i https://try.vikunja.io/api/v1/docs.json -o vikunja_sdk -g typescript-fetch --additional-properties "supportsES6=true,npmVersion=10.8.1,typescriptThreePlus=true"
# or
npm run gen-sdkYou can simplify the version bump process by running
npm version patch,npm version minorornpm version majorafter updatingminAppVersionmanually inmanifest.json. The command will bump version inmanifest.jsonandpackage.json, and add the entry for the new version toversions.json
- Copy over
main.js,styles.css,manifest.jsonto your vaultVaultFolder/.obsidian/plugins/your-plugin-id/.
- ESLint is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
- To use eslint with this project, make sure to install eslint from terminal:
npm install -g eslint
- To use eslint to analyze this project use this command:
eslint main.ts- eslint will then create a report with suggestions for code improvement by file and line number.
- If your source code is in a folder, such as
src, you can use eslint with this command to analyze all files in that folder:eslint .\src\