README file from
GithubTPSReport — Obsidian Plugin
Sync local research folders to TPSReport — graph-native AI knowledge management built for teams, agents, and retrieval.
Official Obsidian companion for TPSReport AI Brain & Knowledge Management.
Write in your vault. Publish structured knowledge reports. Sync Markdown, metadata, and images to a cloud workspace built for Graph RAG, access control, and agent-ready retrieval.
Publisher: Augmentable LLC
Home: tpsreport.pro · Privacy: tpsreport.pro/privacy · Terms: tpsreport.pro/terms
What is TPSReport?
TPSReport turns scattered notes and research into graph-structured intelligence — not just files in a folder, but connected knowledge that AI agents and humans can navigate.
Most tools treat knowledge as isolated documents. TPSReport helps you curate, codify, and connect expertise into reports and collections optimized for:
- Graph RAG — vector search plus explicit relationships, categories, and metadata
- Knowledge operations — freshness, staleness alerts, and usage-aware maintenance
- Multi-scope collections — personal research, team wikis, and org-wide knowledge bases
- Rendered reports — publish, share, and control access from your TPSReport workspace
This plugin is the bridge between Obsidian (where you write) and TPSReport (where you manage, index, query, and deliver knowledge at scale).
→ Learn more about TPSReport · Use cases · FAQ
Why use this plugin?
| You want to… | TPSReport + Obsidian gives you… |
|---|---|
| Publish vault research as structured reports | One-click Publish as New Report from any folder |
| Keep local notes and cloud reports in sync | Bidirectional push/pull with stable node_id identity |
| Improve AI retrieval quality | Rich YAML frontmatter (keywords, intents, entities, …) synced to Graph RAG |
| Sync images with Markdown | Optional embedded image upload/download |
| Avoid silent overwrites | Conflict detection + reviewable conflict copies |
| Control visibility & destinations | Per-report visibility, edit scope, and account destinations |
Install
From Obsidian Community Plugins (recommended)
- Open Settings → Community plugins → Browse
- Search for TPSReport
- Install and enable
Manual / beta install
Download main.js, manifest.json, and styles.css from the latest release.
Requires a free TPSReport account and an API key (obs_...) from your dashboard.
Quick start
- Sign up at tpsreport.pro
- Generate an API key in your TPSReport dashboard (
obs_...) - In Obsidian: Settings → TPSReport → paste key → Test Connection
- Right-click a vault folder → Publish as New Report
- Push, pull, and manage sync from the command palette or folder menu
Features
- Publish Obsidian folders as TPSReport knowledge reports
- Sync Markdown, nested folders, frontmatter, and local images
- Pull cloud updates back into mapped vault folders
- Preserve stable
node_idfrontmatter for ID-first reconciliation - Detect conflicts; create conflict copies instead of silent data loss
- Choose account-enabled report destinations
- Optionally enable RAG indexing for report content in your TPSReport knowledge base
AI generation, indexing, rendered report hosting, and access control run in your TPSReport cloud workspace — this plugin handles local ↔ cloud synchronization.
Configuration
Open Settings → TPSReport in Obsidian:
| Setting | Details |
|---|---|
| TPSReport API Key | Your obs_... key. Stored locally in plugin data. |
| Frontmatter ID field | Stable identity field (recommended: node_id). |
| Default report settings | Visibility, edit scope, content format, RAG, destination defaults. |
| Image sync | Upload embedded images on push; download on pull. |
| Folder mapping | Map vault folders to cloud TPSReport reports. |
Frontmatter for better retrieval
Add YAML properties to improve Graph RAG accuracy in TPSReport:
---
summary: Short retrieval-friendly summary of this note.
keywords: [product-name, category, region]
tags: [research, catalog]
intents: [product_lookup, business_recommendation]
entities: [Brand Name, Product SKU]
retrieval_hint: One sentence a search agent should match on.
---
Supported fields include summary, keywords, tags, intents, scenarios, entities, topics, brands, product_skus, audience, region, and more.
Privacy & data handling
- No vault content is sent until you configure an API key and explicitly publish, push, or pull.
- API keys are stored locally in Obsidian and sent only to the TPSReport API.
- Synced content is governed by your report visibility settings in TPSReport.
Full policy: tpsreport.pro/privacy · Terms: tpsreport.pro/terms
Links
| Resource | URL |
|---|---|
| TPSReport home | tpsreport.pro |
| What is TPSReport? | docs/about-tpsreport.md |
| Use cases | docs/use-cases.md |
| FAQ | docs/faq.md |
| Plugin releases | GitHub Releases |
| Obsidian listing | community.obsidian.md |
| Privacy | tpsreport.pro/privacy |
| Terms | tpsreport.pro/terms |
| Support | [email protected] |
Keywords
Obsidian plugin · knowledge management · research sync · Markdown sync · Graph RAG · AI knowledge base · institutional knowledge · note publishing · vault sync · TPSReport · tpsreport.pro · Augmentable LLC
License
MIT — see LICENSE.
Current version: 1.2.1 · Updates ship via GitHub releases tagged to match manifest.json.