Bauer

Info Start with docs/specs. The current README may be out of date while the v2 and v2.1 work is in progress.

A proof-of-concept Go application that extracts document content, suggestions (proposed edits), and comments from Google Docs using the Google Docs API and Google Drive API.

Local development

Prerequisites

1. Install go
2. Install task

Steps

1. Build the project

task build

2. Run the project

./bauer --doc-id <doc-id> \
  --credentials <path-to-creds> \
  --parse-only

Configuration

1. Create a credentials file by copying the example

cp credentials.example.json credentials.json

2. Get credentials from Google Cloud service or Bitwarden (internally)
3. Fill up credentials.json with Google Cloud credentials (see Generating Google Cloud credentials).
4. Share copy document with service account

Usage

1. Build Bauer locally using the Local development steps above (task build)
2. If running with GitHub integration (no --parse-only), ensure copilot is installed and authenticated
3. Get document ID from Google Document & share the document with the service account
4. Run Bauer

./bauer --doc-id <your-document-id> --credentials ./credentials.json

5. Optional parameters

Flag	Type	Default	Description	Requires Copilot
--github-repo	string	(required if not parse-only)	GitHub repository (owner/repo or HTTPS URL)	Yes*
--credentials	string	bau-test-creds.json	Path to service account credentials JSON	No
--local-repo-path	string	/tmp/ubuntu.com	Local path for cloned repository	No
--dry-run	bool	false	Perform a dry run without creating PR	Yes*
--output-dir	string	bauer-output	Output directory for Bauer results	No
--branch-prefix	string	bauer	Branch naming prefix	No
--parse-only	bool	false	Parse document and output machine-readable JSON (skip GitHub integration)	No

*These flags require Copilot integration to be configured when performing GitHub operations (not needed for --parse-only)

Documentation

For more information refer to ARCHITECTURE.md