Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Dependencies

uv sync --extra s3
GCS uses the same aiobotocore dependency as S3 (GCS exposes an S3-compatible XML API via HMAC keys). For credential setup, see the GCS Setup guide.

​
Configuration

import os
from mirage import Workspace, MountMode
from mirage.resource.gcs import GCSConfig, GCSResource

config = GCSConfig(
    bucket=os.environ["GCS_BUCKET"],
    access_key_id=os.environ["GCS_ACCESS_KEY_ID"],
    secret_access_key=os.environ["GCS_SECRET_ACCESS_KEY"],
)
resource = GCSResource(config)
ws = Workspace({"/gcs/": resource}, mode=MountMode.READ)

​
Config Reference

FieldRequiredDefaultDescription
bucketYesGCS bucket name
access_key_idYesHMAC access key
secret_access_keyYesHMAC secret key
endpoint_urlNohttps://storage.googleapis.comCustom endpoint (override if needed)
regionNoautoRegion
timeoutNo30Request timeout in seconds
proxyNoNoneHTTP proxy URL