Expand description
org-gdocs — publish a projection of an org-mode document to Google Docs and
sync reviewer comments back into the org file.
Org-mode is the single source of truth; Google Docs is a collaboration surface for comments only. This crate owns all testable logic (org projection, the Google API client, comment anchoring, file writeback); the companion Emacs package is a thin shell over the binary.
See docs/plans/org-gdocs.md for the architecture and invariants this crate
is built against.
Re-exports§
Modules§
- auth
- OAuth 2.0 authentication via the installed-app (loopback) flow.
- clean
- Q3 — the
cleancommand: archive the comments the operator markedDONE. - cli
- Command-line argument definitions for
org-gdocs. - comments
- Q1 — mapping a Google comment back to the org structural element it anchors to.
- comments_
meta - P6 — the
** Active Commentssubtree: human-facingTODO/DONEheadings, one per pulled Google comment, keyed by:COMMENT_ID:. - config
- Configuration and filesystem-path resolution.
- custom_
id - Stable section ids and their surgical insertion (P2).
- doctor
- Health-check provider for
org-gdocs. - envelope
- The CLI ↔ Emacs result envelope (A5): a single s-expression the binary prints
for domain commands, which
org-gdocs.elreads with(read …). - error
- Typed error surface for the
org-gdocslibrary. - Google API integration: the Docs/Drive hubs and index arithmetic.
- open
- Q3 — the
opencommand: report the linked doc’s browser URL for elisp tobrowse-url. - orgfile
- Two-region model of a synced org file: the user’s body and the
tool-owned machine region, split at the
* GDOC_METADATAheading. - project
- P3 — projecting an org document into Google Docs
batchUpdaterequests. - pull
- Q2 — the
pullorchestration: fetch reviewer comments from the linked Google Doc and merge them into the org file as structural-anchoredTODOheadings. - push
- P7 — the
pushorchestration: publish the org body’s projection to its linked Google Doc and write machine state back into the file. - sexp
- Minimal s-expression reader/writer for the surfaces org-gdocs owns (A5).
- syncstate
- P5 — the tool-owned
** Sync Stateblock.
Constants§
- TOOL_
SPEC - Shared CLI metadata for the
org-gdocsbinary.