Quickstart

The fastest path is hosted: Agent Relay runs the integration stack for you — OAuth, sync workers, writeback — so you only run a local mount. One command signs you up and puts provider-backed files in an ordinary directory.

One command

From the project where your agent will work, run:

npx relayfile@latest

Relayfile opens Google sign-in, creates your account and a workspace named after the current directory, connects GitHub, and mounts at ./relayfile-mount. No invite code, API token, existing Cloud account, or separate agent-relay installation is required.

Keep that terminal open for synchronization. In another terminal, ./relayfile-mount is the live mirror of your workspace:

ls ./relayfile-mount/github
cat ./relayfile-mount/LAYOUT.md

For a different provider or explicit names, use:

npx relayfile@latest setup \
  --provider notion \
  --workspace my-agent \
  --local-dir ./relayfile-mount

Add --no-open to print the hosted login and connect URLs instead of opening a browser, which is useful inside agents and headless environments.

See Relayfile Cloud for what the hosted plane manages, and Mounting to do the same thing programmatically from a sandbox.

Read and write

Once mounted, the interface is the filesystem you already know:

# read
cat ./relayfile-mount/github/repos/acme/api/pulls/42/metadata.json

# post a pull-request review by writing the canonical path
cat > ./relayfile-mount/github/repos/acme/api/pulls/42/reviews/review.json <<'EOF'
{"body":"Looks good to me.","event":"COMMENT"}
EOF

# find pull requests across connected repositories
find ./relayfile-mount/github/repos -path '*/pulls/*/metadata.json'

See Reads and writes for the full PATCH / CREATE / DELETE model.

Next steps