Privacy & Secrets Policy
Open Document Spec (ODS) is engineered with a strict Local-First, Zero-Telemetry, and Share-Aware Isolation architecture. Your documentation, code, and workspace data never leave your environment.
1. Executive Summary & Core Guarantees
Open Document Spec (ODS) provides automated Markdown index management, graph link repair, and AI context resolution. We believe developer tools must respect codebase privacy and data sovereignty above all else.
🔒 Local-First Engine
All indexing, link repair, schema validation, and graph operations execute 100% locally on your CPU via the compiled Rust binary (ods). No code or prose is ever sent to external cloud servers.
🚫 Zero Telemetry & Tracking
ODS contains zero analytics, tracking beacons, error monitoring reporting, or phone-home telemetry. Your workspace paths, command invocations, and document counts remain entirely private.
🛡️ Share-Aware Visibility Controls
Every document can declare a share: public | org | private visibility key. Sensitive internal designs, architecture notes, and credential references marked share: private are automatically excluded from public exports.
2. Data Storage & Local State
ODS stores configuration and index files exclusively inside your local filesystem:
- Workspace Indexes (
index.md): Generated directly inside your repository tree so they can be versioned with Git. - Global Configuration (
~/.ods/odsconfig.toml): Stores registered workspace paths and user preferences on your local disk. - Daemon IPC State: The background daemon (
ods serve) uses OS-native local inter-process communication (IPC) or loopback sockets with zero public network listeners.
3. Secrets Isolation & share: private Policy
Modern documentation often coexists with internal operational details. ODS implements first-class visibility scoping in frontmatter:
ods:
profile: guide
status: stable
share: private # Automatically excluded from 'ods share' and public AI context exports share: public(Default): Standard documentation included in public site generators and public exports.share: org: Restricts exports to internal organizational boundaries.share: private: Strictly isolated. Excluded fromods shareoutputs andods contextdumps unless explicitly passed with--include-privatein local execution.
4. Third-Party AI Models & IDE Integrations
When you use ODS with AI coding assistants (Claude Desktop, Cursor, VS Code, Zed, Windsurf, or Antigravity):
- ODS acts as a local context provider. It generates bounded Markdown reading lists (
ods context <id>) directly on your machine. - ODS does not transmit your documentation to third-party AI providers. Any data sent to an LLM provider is governed strictly by your own AI client's privacy settings and API agreements.
5. Updates & Version Checking
When running ods update --check, the CLI makes an anonymous HTTPS GET request to GitHub's public API (api.github.com/repos/StaytunedLLP/open-document-specs/releases/latest) solely to check if a higher version tag exists. No workspace data, repository contents, or user identifiers are included in this check.
6. Licensing & Open Source Commitment
Open Document Spec core is open-source software licensed under the Apache License, Version 2.0. You are free to inspect, audit, modify, and self-host all ODS core components.
For security inquiries or vulnerability reports, please visit our GitHub Repository or contact Staytuned LLP.