chore: import upstream snapshot with attribution
Integ / changes (push) Has been skipped
Pre-commit / pre-commit (push) Failing after 1s
CLI exit codes / changes (push) Has been skipped
Test (Install) / changes (push) Has been skipped
Test (Python) / changes (push) Has been skipped
Test (TypeScript) / changes (push) Has been skipped
CLI exit codes / cli-gate (push) Has been cancelled
Test (Install) / test-install-gate (push) Has been cancelled
Integ / integ-gate (push) Has been cancelled
Test (Python) / test-python-gate (push) Has been cancelled
Test (TypeScript) / test-typescript-gate (push) Has been cancelled
Test (Install) / python-minimal (3.12) (push) Has been cancelled
Test (Install) / python-minimal (3.11) (push) Has been cancelled
Test (Install) / python-extra (agno, mirage.agents.agno) (push) Has been cancelled
Test (Install) / python-extra (chroma, mirage.resource.chroma) (push) Has been cancelled
Test (Install) / python-extra (pdf, mirage.core.filetype.pdf) (push) Has been cancelled
Integ / integ (push) Has been cancelled
Integ / integ-database (push) Has been cancelled
Integ / integ-database-ts (push) Has been cancelled
Integ / integ-data (push) Has been cancelled
Integ / integ-ssh (push) Has been cancelled
Integ / integ-ssh-ts (push) Has been cancelled
Test (Python) / audit (push) Has been cancelled
Test (TypeScript) / test (push) Has been cancelled
Test (TypeScript) / python-fs-shim (push) Has been cancelled
CLI exit codes / Python CLI (push) Has been cancelled
CLI exit codes / TypeScript CLI (push) Has been cancelled
CLI exit codes / Cross-language snapshot interop (push) Has been cancelled
Test (Python) / test (push) Has been cancelled
Test (Python) / import-isolation (deepagents, openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Python) / import-isolation (deepagents, pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Integ / integ-ts (push) Has been cancelled
Integ / integ-fuse (push) Has been cancelled
Test (Install) / python-extra (databricks, mirage.resource.databricks_volume) (push) Has been cancelled
Test (Install) / python-extra (deepagents, mirage.agents.langchain) (push) Has been cancelled
Test (Install) / python-extra (email, mirage.resource.email) (push) Has been cancelled
Test (Install) / python-extra (fuse, mirage.fuse.mount) (push) Has been cancelled
Test (Install) / python-extra (hdf5, mirage.core.filetype.hdf5) (push) Has been cancelled
Test (Install) / python-extra (hf, mirage.resource.hf_buckets) (push) Has been cancelled
Test (Install) / python-extra (lancedb, mirage.resource.lancedb) (push) Has been cancelled
Test (Install) / python-extra (langfuse, mirage.resource.langfuse) (push) Has been cancelled
Test (Install) / python-extra (mongodb, mirage.resource.mongodb) (push) Has been cancelled
Test (Install) / python-extra (nextcloud, mirage.resource.nextcloud) (push) Has been cancelled
Test (Install) / python-extra (openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Install) / python-extra (openhands, mirage.agents.openhands, 3.12) (push) Has been cancelled
Test (Install) / python-extra (parquet, mirage.core.filetype.parquet) (push) Has been cancelled
Test (Install) / python-extra (postgres, mirage.resource.postgres) (push) Has been cancelled
Test (Install) / python-extra (pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Test (Install) / python-extra (qdrant, mirage.resource.qdrant) (push) Has been cancelled
Test (Install) / python-extra (redis, mirage.resource.redis) (push) Has been cancelled
Test (Install) / python-extra (s3, mirage.resource.s3) (push) Has been cancelled
Test (Install) / python-extra (ssh, mirage.resource.ssh) (push) Has been cancelled
Test (Install) / ts-minimal (push) Has been cancelled
Integ / changes (push) Has been skipped
Pre-commit / pre-commit (push) Failing after 1s
CLI exit codes / changes (push) Has been skipped
Test (Install) / changes (push) Has been skipped
Test (Python) / changes (push) Has been skipped
Test (TypeScript) / changes (push) Has been skipped
CLI exit codes / cli-gate (push) Has been cancelled
Test (Install) / test-install-gate (push) Has been cancelled
Integ / integ-gate (push) Has been cancelled
Test (Python) / test-python-gate (push) Has been cancelled
Test (TypeScript) / test-typescript-gate (push) Has been cancelled
Test (Install) / python-minimal (3.12) (push) Has been cancelled
Test (Install) / python-minimal (3.11) (push) Has been cancelled
Test (Install) / python-extra (agno, mirage.agents.agno) (push) Has been cancelled
Test (Install) / python-extra (chroma, mirage.resource.chroma) (push) Has been cancelled
Test (Install) / python-extra (pdf, mirage.core.filetype.pdf) (push) Has been cancelled
Integ / integ (push) Has been cancelled
Integ / integ-database (push) Has been cancelled
Integ / integ-database-ts (push) Has been cancelled
Integ / integ-data (push) Has been cancelled
Integ / integ-ssh (push) Has been cancelled
Integ / integ-ssh-ts (push) Has been cancelled
Test (Python) / audit (push) Has been cancelled
Test (TypeScript) / test (push) Has been cancelled
Test (TypeScript) / python-fs-shim (push) Has been cancelled
CLI exit codes / Python CLI (push) Has been cancelled
CLI exit codes / TypeScript CLI (push) Has been cancelled
CLI exit codes / Cross-language snapshot interop (push) Has been cancelled
Test (Python) / test (push) Has been cancelled
Test (Python) / import-isolation (deepagents, openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Python) / import-isolation (deepagents, pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Integ / integ-ts (push) Has been cancelled
Integ / integ-fuse (push) Has been cancelled
Test (Install) / python-extra (databricks, mirage.resource.databricks_volume) (push) Has been cancelled
Test (Install) / python-extra (deepagents, mirage.agents.langchain) (push) Has been cancelled
Test (Install) / python-extra (email, mirage.resource.email) (push) Has been cancelled
Test (Install) / python-extra (fuse, mirage.fuse.mount) (push) Has been cancelled
Test (Install) / python-extra (hdf5, mirage.core.filetype.hdf5) (push) Has been cancelled
Test (Install) / python-extra (hf, mirage.resource.hf_buckets) (push) Has been cancelled
Test (Install) / python-extra (lancedb, mirage.resource.lancedb) (push) Has been cancelled
Test (Install) / python-extra (langfuse, mirage.resource.langfuse) (push) Has been cancelled
Test (Install) / python-extra (mongodb, mirage.resource.mongodb) (push) Has been cancelled
Test (Install) / python-extra (nextcloud, mirage.resource.nextcloud) (push) Has been cancelled
Test (Install) / python-extra (openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Install) / python-extra (openhands, mirage.agents.openhands, 3.12) (push) Has been cancelled
Test (Install) / python-extra (parquet, mirage.core.filetype.parquet) (push) Has been cancelled
Test (Install) / python-extra (postgres, mirage.resource.postgres) (push) Has been cancelled
Test (Install) / python-extra (pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Test (Install) / python-extra (qdrant, mirage.resource.qdrant) (push) Has been cancelled
Test (Install) / python-extra (redis, mirage.resource.redis) (push) Has been cancelled
Test (Install) / python-extra (s3, mirage.resource.s3) (push) Has been cancelled
Test (Install) / python-extra (ssh, mirage.resource.ssh) (push) Has been cancelled
Test (Install) / ts-minimal (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,198 @@
|
||||
---
|
||||
title: Google Docs
|
||||
description: Mount Google Docs as JSON-backed files so Python agents can read document structure and content through Mirage.
|
||||
icon: file-lines
|
||||
---
|
||||
The Google Docs resource exposes Docs documents as a virtual filesystem
|
||||
mounted at some prefix such as `/gdocs/`.
|
||||
|
||||
For Google OAuth setup, see [Google Workspace Setup](/python/setup/google).
|
||||
|
||||
## Config
|
||||
|
||||
```python
|
||||
import os
|
||||
|
||||
from mirage import MountMode, Workspace
|
||||
from mirage.resource.gdocs import GDocsConfig, GDocsResource
|
||||
|
||||
config = GDocsConfig(
|
||||
client_id=os.environ["GOOGLE_CLIENT_ID"],
|
||||
client_secret=os.environ["GOOGLE_CLIENT_SECRET"],
|
||||
refresh_token=os.environ["GOOGLE_REFRESH_TOKEN"],
|
||||
)
|
||||
resource = GDocsResource(config=config)
|
||||
ws = Workspace({"/gdocs": resource}, mode=MountMode.READ)
|
||||
```
|
||||
|
||||
## Filesystem Layout
|
||||
|
||||
```text
|
||||
/gdocs/
|
||||
owned/
|
||||
<YYYY-MM-DD>_<sanitized-title>__<doc-id>.gdoc.json
|
||||
...
|
||||
shared/
|
||||
<YYYY-MM-DD>_<sanitized-title>__<doc-id>.gdoc.json
|
||||
...
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```text
|
||||
/gdocs/
|
||||
owned/
|
||||
2026-04-04_Project_Plan__1AbCdEf.gdoc.json
|
||||
2026-04-10_Meeting_Notes__2BcDeFg.gdoc.json
|
||||
shared/
|
||||
2026-04-03_Design_Notes__9XyZ.gdoc.json
|
||||
```
|
||||
|
||||
Documents are split into `owned` (documents you created) and `shared`
|
||||
(documents shared with you). The filename shape is:
|
||||
|
||||
```text
|
||||
<YYYY-MM-DD>_<sanitized-title>__<document-id>.gdoc.json
|
||||
```
|
||||
|
||||
If the modified date is unavailable, the date prefix is omitted.
|
||||
Reading a document file returns the full Google Docs API JSON for
|
||||
that document.
|
||||
|
||||
## Cache
|
||||
|
||||
The Google Docs resource uses `IndexCacheStore`. Index entries store
|
||||
document IDs and metadata. There is no separate content cache -- file
|
||||
content caching is handled by the workspace `IOResult` mechanism.
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
import os
|
||||
|
||||
from dotenv import load_dotenv
|
||||
|
||||
from mirage import MountMode, Workspace
|
||||
from mirage.resource.gdocs import GDocsConfig, GDocsResource
|
||||
|
||||
load_dotenv(".env.development")
|
||||
|
||||
config = GDocsConfig(
|
||||
client_id=os.environ["GOOGLE_CLIENT_ID"],
|
||||
client_secret=os.environ["GOOGLE_CLIENT_SECRET"],
|
||||
refresh_token=os.environ["GOOGLE_REFRESH_TOKEN"],
|
||||
)
|
||||
resource = GDocsResource(config=config)
|
||||
|
||||
|
||||
async def main():
|
||||
ws = Workspace({"/gdocs": resource}, mode=MountMode.READ)
|
||||
|
||||
# List structure
|
||||
r = await ws.execute("ls /gdocs/")
|
||||
print(await r.stdout_str())
|
||||
|
||||
# List owned documents
|
||||
r = await ws.execute("ls /gdocs/owned/")
|
||||
print(await r.stdout_str())
|
||||
|
||||
# Read a document
|
||||
r = await ws.execute(
|
||||
"cat /gdocs/owned/2026-04-04_Project_Plan__1AbCdEf.gdoc.json")
|
||||
print(await r.stdout_str())
|
||||
|
||||
# Extract title with jq
|
||||
r = await ws.execute(
|
||||
'jq ".title"'
|
||||
" /gdocs/owned/2026-04-04_Project_Plan__1AbCdEf.gdoc.json")
|
||||
print(await r.stdout_str())
|
||||
|
||||
# Search across all documents
|
||||
r = await ws.execute('rg "quarterly" /gdocs/owned/')
|
||||
print(await r.stdout_str())
|
||||
|
||||
# Tree view
|
||||
r = await ws.execute("tree -L 1 /gdocs/")
|
||||
print(await r.stdout_str())
|
||||
|
||||
# Create a new document
|
||||
r = await ws.execute(
|
||||
'gws-docs-documents-create --json \'{"title":"MIRAGE Example Doc"}\'')
|
||||
print(await r.stdout_str())
|
||||
|
||||
# Append text to a document
|
||||
r = await ws.execute(
|
||||
'gws-docs-write --document 1AbCdEf --text "Appended via MIRAGE."')
|
||||
print(await r.stdout_str())
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
See `examples/gdocs/gdocs.py` for the full working example.
|
||||
|
||||
## Shell Commands
|
||||
|
||||
Standard commands available on the mounted Google Docs tree:
|
||||
|
||||
| Command | Notes |
|
||||
| ----------------------------------- | --------------------------- |
|
||||
| `ls` | List owned/shared documents |
|
||||
| `cat` | Read document JSON |
|
||||
| `head` / `tail` | First/last N lines |
|
||||
| `grep` / `rg` | Pattern search |
|
||||
| `jq` | Query JSON fields |
|
||||
| `wc` | Line/word/byte counts |
|
||||
| `stat` | File metadata |
|
||||
| `find` | Recursive search |
|
||||
| `tree` | Directory tree view |
|
||||
| `basename` / `dirname` / `realpath` | Path utilities |
|
||||
| `nl` | Number lines |
|
||||
|
||||
Resource-specific commands:
|
||||
|
||||
### `gws-docs-documents-create`
|
||||
|
||||
Create a new Google Docs document.
|
||||
|
||||
```bash
|
||||
gws-docs-documents-create --json '{"title":"MIRAGE Example Doc"}'
|
||||
```
|
||||
|
||||
| Option | Required | Description |
|
||||
| -------- | -------- | ---------------------------- |
|
||||
| `--json` | yes | JSON body with `title` field |
|
||||
|
||||
Returns the created document JSON.
|
||||
|
||||
### `gws-docs-documents-batchUpdate`
|
||||
|
||||
Batch update a document.
|
||||
|
||||
```bash
|
||||
gws-docs-documents-batchUpdate --params '{"documentId":"1AbCdEf"}' --json '{"requests":[]}'
|
||||
```
|
||||
|
||||
| Option | Required | Description |
|
||||
| ---------- | -------- | -------------------------- |
|
||||
| `--params` | yes | JSON with `documentId` |
|
||||
| `--json` | yes | JSON with `requests` array |
|
||||
|
||||
Returns the batch update response JSON.
|
||||
|
||||
### `gws-docs-write`
|
||||
|
||||
Append text to a document.
|
||||
|
||||
```bash
|
||||
gws-docs-write --document 1AbCdEf --text "Appended via MIRAGE."
|
||||
```
|
||||
|
||||
| Option | Required | Description |
|
||||
| ------------ | -------- | ------------------ |
|
||||
| `--document` | yes | Google document ID |
|
||||
| `--text` | yes | Text to append |
|
||||
|
||||
Returns the update response JSON.
|
||||
Reference in New Issue
Block a user