Mindwtr

https://docs.mindwtr.app
Admin
Mindwtr is a free, open-source task manager built around Getting Things Done (GTD) that works...
Tokens:60,545
Snippets:953
Trust Score:4.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Quick Start Configuration

Source: https://docs.mindwtr.app/power-users/local-api

Basic setup instructions for enabling the API and identifying the default endpoint.

```text
Settings -> Advanced -> Enable local API server
```

```text
http://127.0.0.1:3456
```

--------------------------------

### Start API with Bun

Source: https://docs.mindwtr.app/power-users/local-api

Command to install dependencies and launch the API server using the Bun helper.

```bash
bun install
bun run mindwtr:api -- --port 4317 --host 127.0.0.1
```

--------------------------------

### Run PWA Locally with Bun

Source: https://docs.mindwtr.app/power-users/web-app-pwa

Commands to install dependencies and start the development server for the web application.

```bash
bun install
bun desktop:web
```

--------------------------------

### Get project input example

Source: https://docs.mindwtr.app/power-users/mcp

Example input for the mindwtr_get_project tool.

```json
{ "id": "project-uuid" }
```

--------------------------------

### Install and Run Globally

Source: https://docs.mindwtr.app/power-users/mcp

Install the package globally via npm and execute it directly.

```bash
npm install -g mindwtr-mcp
mindwtr-mcp --db "/path/to/mindwtr.db"
```

--------------------------------

### Install Desktop Prerequisites on macOS

Source: https://docs.mindwtr.app/developers/developer-guide

Command line tools and Rust installation for macOS development.

```bash
xcode-select --install
brew install rust
```

--------------------------------

### Install Mindwtr via Snap

Source: https://docs.mindwtr.app/start/desktop-installation

Command to install the application from the Snap Store.

```bash
sudo snap install mindwtr
```

--------------------------------

### Install Desktop Prerequisites on Linux (Debian/Ubuntu)

Source: https://docs.mindwtr.app/developers/developer-guide

System dependencies and Rust installation for Tauri development on Debian-based systems.

```bash
sudo apt install libwebkit2gtk-4.1-dev build-essential libssl-dev libgtk-3-dev \
  cmake perl libasound2-dev libayatana-appindicator3-dev
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

--------------------------------

### Start cloud server

Source: https://docs.mindwtr.app/developers/developer-guide

Run the cloud sync backend from the monorepo root.

```bash
# From monorepo root
bun run --filter mindwtr-cloud dev -- --port 8787
```

--------------------------------

### Install prebuilt AUR package

Source: https://docs.mindwtr.app/start/faq

Recommended command for Arch-based distributions to install the prebuilt binary package instead of building from source.

```bash
yay -S mindwtr-bin
```

--------------------------------

### Initialize HTTPS Configuration

Source: https://docs.mindwtr.app/power-users/docker-deployment

Copies the HTTPS environment example file to a local configuration file.

```bash
cp docker/.env.https.example docker/.env.https.local
```

--------------------------------

### Get task input example

Source: https://docs.mindwtr.app/power-users/mcp

Example input for the mindwtr_get_task tool.

```json
{ "id": "task-uuid" }
```

--------------------------------

### Start Docker Services

Source: https://docs.mindwtr.app/power-users/docker-deployment

Pulls the necessary images and starts the containers in detached mode.

```bash
docker compose pull
docker compose up -d
```

--------------------------------

### Install Mindwtr via Scoop

Source: https://docs.mindwtr.app/start/desktop-installation

Add the Mindwtr bucket and install the application using Scoop.

```powershell
scoop bucket add mindwtr https://github.com/dongdongbh/homebrew-mindwtr
scoop install mindwtr
```

--------------------------------

### Install Mindwtr on Fedora/RHEL/openSUSE

Source: https://docs.mindwtr.app/start/desktop-installation

Configure the YUM repository and install the application using DNF.

```bash
cat <<'EOF' | sudo tee /etc/yum.repos.d/mindwtr.repo
[mindwtr]
name=Mindwtr Repository
baseurl=https://dongdongbh.github.io/Mindwtr/rpm
enabled=1
gpgcheck=0
EOF

sudo dnf install mindwtr
```

--------------------------------

### List projects response example

Source: https://docs.mindwtr.app/power-users/mcp

Example response structure for the mindwtr_list_projects tool.

```json
{
  "projects": [
    {
      "id": "project-uuid",
      "title": "Mindwtr",
      "status": "active"
    }
  ]
}
```

--------------------------------

### Install AUR Beta Package

Source: https://docs.mindwtr.app/start/beta-channels

Use yay to install the beta version of Mindwtr on Arch Linux.

```bash
yay -S mindwtr-bin-beta
```

--------------------------------

### API Usage Examples

Source: https://docs.mindwtr.app/power-users/local-api

Common cURL commands for interacting with tasks.

```bash
curl -s 'http://127.0.0.1:3456/tasks?status=next' \
  -H 'Authorization: Bearer <token>' | jq .
```

```bash
curl -s -X POST 'http://127.0.0.1:3456/tasks' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"title":"Call Alice","props":{"status":"next","contexts":["@phone"],"tags":["#errands"]}}' | jq .
```

```bash
curl -s -X POST "http://127.0.0.1:3456/tasks/$TASK_ID/complete" \
  -H 'Authorization: Bearer <token>' | jq .
```

--------------------------------

### Run local REST API server

Source: https://docs.mindwtr.app/developers/developer-guide

Commands to start the API server, optionally with an authentication token.

```bash
# Start API server
bun mindwtr:api -- --port 4317

# With auth token
MINDWTR_API_TOKEN=secret bun mindwtr:api -- --port 4317
```

--------------------------------

### Install and Run Mindwtr via Flatpak

Source: https://docs.mindwtr.app/start/desktop-installation

Commands to install and execute the application using the Flatpak package manager.

```bash
flatpak install flathub tech.dongdongbh.mindwtr
```

```bash
flatpak run tech.dongdongbh.mindwtr
```

--------------------------------

### GET /projects

Source: https://docs.mindwtr.app/power-users/local-api

Lists all projects.

```APIDOC
## GET /projects

### Description
Retrieves a list of all projects.

### Method
GET

### Endpoint
/projects
```

--------------------------------

### Install Mindwtr on Debian/Ubuntu

Source: https://docs.mindwtr.app/start/desktop-installation

Add the APT repository and install the package using standard Debian-based tools.

```bash
curl -fsSL https://dongdongbh.github.io/Mindwtr/mindwtr.gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/mindwtr-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/mindwtr-archive-keyring.gpg] https://dongdongbh.github.io/Mindwtr/deb ./" | sudo tee /etc/apt/sources.list.d/mindwtr.list
sudo apt update
sudo apt install mindwtr
```

--------------------------------

### Install Desktop Prerequisites on Linux (Arch)

Source: https://docs.mindwtr.app/developers/developer-guide

System dependencies required for Tauri development on Arch Linux.

```bash
sudo pacman -S rust webkit2gtk-4.1 base-devel cmake alsa-lib libayatana-appindicator
```

--------------------------------

### Install Icon Theme

Source: https://docs.mindwtr.app/start/desktop-installation

Command to install the Papirus icon theme to resolve missing icon issues.

```bash
sudo pacman -S papirus-icon-theme
```

--------------------------------

### Start HTTPS Stack

Source: https://docs.mindwtr.app/power-users/docker-deployment

Launches the Docker stack using the HTTPS-specific environment file and compose configuration.

```bash
docker compose --env-file docker/.env.https.local -f docker/compose.https.yaml up -d
```

--------------------------------

### Install and Run Mindwtr AppImage

Source: https://docs.mindwtr.app/start/desktop-installation

Instructions for making the AppImage executable and running it on supported Linux distributions.

```bash
# Download the versioned AppImage from:
# https://github.com/dongdongbh/Mindwtr/releases/latest

# Make executable
chmod +x Mindwtr-*.AppImage

# Run
./Mindwtr-*.AppImage
```

--------------------------------

### Install WebKitGTK Dependencies

Source: https://docs.mindwtr.app/start/desktop-installation

Required system packages for running the application on Linux distributions.

```bash
# Arch
sudo pacman -S webkit2gtk-4.1

# Debian/Ubuntu
sudo apt install libwebkit2gtk-4.1-0
```

--------------------------------

### Clone and Run Mindwtr

Source: https://docs.mindwtr.app/developers/developer-guide

Commands to clone the repository and start the development environment using Bun.

```bash
git clone https://github.com/dongdongbh/Mindwtr.git
cd Mindwtr

# Install dependencies
bun install

# Run desktop app (dev mode)
bun desktop:dev

# Run mobile app
bun mobile:start
```

--------------------------------

### Markdown Link Usage Example

Source: https://docs.mindwtr.app/use/markdown-links

Demonstrates how to embed task and project links within a task description or note.

```markdown
Prepare launch notes for [[project:project-123|Website launch]]

- [ ] Draft intro copy
- [ ] Review [[task:task-456|homepage checklist]]
```

--------------------------------

### mindwtr_add_task

Source: https://docs.mindwtr.app/power-users/mcp

Example of using the quickAdd feature to create a task with natural language parsing.

```APIDOC
### Request Example
{
  "quickAdd": "Follow up with Alex +Hiring @work #ops /due:tomorrow 10am"
}
```

--------------------------------

### Install GStreamer dependencies for Linux

Source: https://docs.mindwtr.app/use/attachments

Required GStreamer plugins for audio playback on various Linux distributions.

```bash
sudo pacman -S gstreamer gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav
```

```bash
sudo apt install gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav
```

```bash
sudo dnf install gstreamer1-plugins-base gstreamer1-plugins-good gstreamer1-plugins-bad-free gstreamer1-plugins-ugly gstreamer1-libav
```

--------------------------------

### Configure Flathub Beta

Source: https://docs.mindwtr.app/start/beta-channels

Commands to add the Flathub beta remote and install the beta branch of Mindwtr.

```bash
flatpak remote-add --if-not-exists flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo
flatpak install flathub-beta tech.dongdongbh.mindwtr//beta
```

```bash
flatpak run --branch=beta tech.dongdongbh.mindwtr
```

```bash
flatpak make-current tech.dongdongbh.mindwtr beta
```

```bash
flatpak make-current tech.dongdongbh.mindwtr stable
```

--------------------------------

### Get person input example

Source: https://docs.mindwtr.app/power-users/mcp

Example input for the mindwtr_get_person tool.

```json
{ "id": "person-uuid" }
```

--------------------------------

### Get section input example

Source: https://docs.mindwtr.app/power-users/mcp

Example input for the mindwtr_get_section tool.

```json
{ "id": "section-uuid" }
```

--------------------------------

### Configure APT Beta Repository

Source: https://docs.mindwtr.app/start/beta-channels

Add the beta APT repository for Debian and Ubuntu systems.

```bash
curl -fsSL https://dongdongbh.github.io/Mindwtr/mindwtr.gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/mindwtr-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/mindwtr-archive-keyring.gpg] https://dongdongbh.github.io/Mindwtr/deb-beta ./" | sudo tee /etc/apt/sources.list.d/mindwtr-beta.list
sudo apt update
sudo apt install mindwtr
```

--------------------------------

### List people response example

Source: https://docs.mindwtr.app/power-users/mcp

Example response structure for the mindwtr_list_people tool.

```json
{
  "people": [
    {
      "id": "person-uuid",
      "name": "Alex"
    }
  ]
}
```

--------------------------------

### Run Development and Production Build Commands

Source: https://docs.mindwtr.app/developers/developer-guide

Use these commands to start the development environment or generate a production build.

```bash
bun desktop:web
```

```bash
bun desktop:web:build
```

--------------------------------

### List areas response example

Source: https://docs.mindwtr.app/power-users/mcp

Example response structure for the mindwtr_list_areas tool.

```json
{
  "areas": [
    {
      "id": "area-uuid",
      "name": "Work"
    }
  ]
}
```

--------------------------------

### List sections response example

Source: https://docs.mindwtr.app/power-users/mcp

Example response structure for the mindwtr_list_sections tool.

```json
{
  "sections": [
    {
      "id": "section-uuid",
      "projectId": "project-uuid",
      "title": "Planning"
    }
  ]
}
```

--------------------------------

### List tasks response example

Source: https://docs.mindwtr.app/power-users/mcp

Example response structure for the mindwtr_list_tasks tool.

```json
{
  "tasks": [
    {
      "id": "task-uuid",
      "title": "Follow up with design",
      "status": "next",
      "updatedAt": "2026-01-25T03:45:57.246Z"
    }
  ]
}
```

--------------------------------

### Quick-Add Batch Syntax

Source: https://docs.mindwtr.app/import

Example of the text format used for bulk task creation via copy-paste or text file import, supporting inline metadata tokens.

```text
Email Bob about Q3 report +Work @computer #followup /due:friday
Book dentist appointment @phone
Outline conference talk +Speaking #ideas /note:Draft the rough structure first
```

```text
Pay water bill +Home /due:2026-07-01
Renew passport +Personal @errands #admin
Send slides to Ana +Work /note:Use the final deck from the shared folder
```

--------------------------------

### Build Desktop App with Diagnostics

Source: https://docs.mindwtr.app/data-sync/diagnostics-logs

Use these commands to build the desktop application with the diagnostics feature enabled and launch it with logging active.

```bash
cd apps/desktop
cargo tauri build --features diagnostics
MINDWTR_DIAGNOSTICS=1 ./src-tauri/target/release/mindwtr
```

--------------------------------

### Install Mindwtr via Homebrew

Source: https://docs.mindwtr.app/start/desktop-installation

Use Homebrew to install the Mindwtr cask on macOS.

```bash
brew install --cask mindwtr
```

--------------------------------

### Install Mindwtr via Chocolatey

Source: https://docs.mindwtr.app/start/desktop-installation

Use the Chocolatey package manager to install Mindwtr.

```powershell
choco install mindwtr
```

--------------------------------

### Build desktop application

Source: https://docs.mindwtr.app/developers/developer-guide

Standard build command for the desktop application, outputting to the release directory.

```bash
cd apps/desktop
bun run build
# Output: src-tauri/target/release/
```

--------------------------------

### List tasks input example

Source: https://docs.mindwtr.app/power-users/mcp

Example input for the mindwtr_list_tasks tool to filter and sort tasks.

```json
{
  "status": "next",
  "limit": 20,
  "offset": 0,
  "sortBy": "updatedAt",
  "sortOrder": "desc"
}
```

--------------------------------

### Configure DNF/YUM Beta Repository

Source: https://docs.mindwtr.app/start/beta-channels

Add the beta DNF/YUM repository for Fedora, RHEL, and openSUSE systems.

```bash
cat <<'EOF' | sudo tee /etc/yum.repos.d/mindwtr-beta.repo
[mindwtr-beta]
name=Mindwtr Beta Repository
baseurl=https://dongdongbh.github.io/Mindwtr/rpm-beta
enabled=1
gpgcheck=0
EOF

sudo dnf install mindwtr
```

--------------------------------

### Build PWA for Hosting

Source: https://docs.mindwtr.app/power-users/web-app-pwa

Command to generate the static build output for deployment.

```bash
bun desktop:web:build
```

--------------------------------

### Install Mindwtr via Winget

Source: https://docs.mindwtr.app/start/desktop-installation

Use the Windows Package Manager to install Mindwtr on Windows 10 and 11.

```powershell
winget install dongdongbh.Mindwtr
```

--------------------------------

### Install Mindwtr on Arch Linux (Prebuilt)

Source: https://docs.mindwtr.app/start/desktop-installation

Use these commands to install the prebuilt AUR package on Arch-based distributions.

```bash
# Using yay
yay -S mindwtr-bin

# Using paru
paru -S mindwtr-bin

# Using pamac (Manjaro)
pamac install mindwtr-bin
```

--------------------------------

### Configuring Storage Adapter

Source: https://docs.mindwtr.app/developers/core-api

Sets the storage backend for the application. This must be called before initializing the store.

```typescript
import { setStorageAdapter } from '@mindwtr/core';

// Must be called before using the store
setStorageAdapter(myStorageAdapter);
```

--------------------------------

### Inspect FOSS and static configurations

Source: https://docs.mindwtr.app/developers/release-process

Commands to verify package changes and configuration files for FOSS distributions.

```bash
git diff vPREV..HEAD -- apps/mobile/package.json
```

```bash
python3 scripts/ci/repair-package-lock.py --check apps/desktop/package-lock.json
```

--------------------------------

### GET /v1/tasks

Source: https://docs.mindwtr.app/developers/developer-guide

Lists tasks.

```APIDOC
## GET /v1/tasks

### Description
Lists tasks.

### Method
GET

### Endpoint
/v1/tasks
```

--------------------------------

### GET /areas

Source: https://docs.mindwtr.app/power-users/local-api

Lists all areas.

```APIDOC
## GET /areas

### Description
Retrieves a list of all areas.

### Method
GET

### Endpoint
/areas
```

--------------------------------

### Add a task using quickAdd

Source: https://docs.mindwtr.app/power-users/mcp

Demonstrates the use of the quickAdd field to create a task with natural language parsing.

```json
{
  "quickAdd": "Send invoice +Acme /due:tomorrow 9am #finance"
}
```

--------------------------------

### GET /v1/search

Source: https://docs.mindwtr.app/developers/developer-guide

Searches tasks and projects.

```APIDOC
## GET /v1/search

### Description
Search tasks and projects.

### Method
GET

### Endpoint
/v1/search
```
Tokens:
Raw