Skip to Content
ConceptsTransports

Transports

nax can submit the same workflow through two transports: GitHub Actions or the local Netlify Agent Runner API. Both paths run agents on Netlify, but they differ in where orchestration happens, how state is recovered, and which logs are easiest to inspect.

Comparison

CapabilityGitHub ActionsNetlify API
Orchestration locationHosted GitHub workflowCurrent machine
SetupWorkflow file plus repo secretsLogged-in Netlify CLI and linked site
Default selectionPreferred by --transport auto when availableUsed when forced or when Actions is unavailable
LogsGitHub Actions logs and uploaded artifactsLocal terminal, .nax, dashboard events
Resume after local interruptionRe-run or sync the Actions artifactResume unfinished local workflow state
Dashboard live eventsLimited to local process visibilityFull local structured event stream
Best forTeam-visible hosted runsInteractive local orchestration and follow-up work

Local Netlify API flow

Use this path when you want local resume, dashboard event streaming, and tight handoff into your current coding session. Your machine must stay available while orchestration is active, but interrupted runs can be resumed from local state.

GitHub Actions flow

Use this path when the team wants hosted logs, GitHub-native visibility, and a machine-independent run. Use nax admin sync when you need to pull remote artifacts back into the local .nax tree.

Choosing a transport

Start with --transport auto unless you need one behavior explicitly.

Use GitHub Actions when the run should be visible to the team, should survive your laptop going offline, or should attach naturally to repository automation.

Use the Netlify API transport when you are driving an interactive investigation, watching the dashboard, or feeding the result directly into another local agent session.

Common mistakes

  • Expecting GitHub Actions runs to have full local live dashboard state. The dashboard is strongest with local Netlify API orchestration.
  • Forcing github-actions before the repository workflow and required secrets exist.
  • Forcing netlify-api on a machine that has not logged in to the Netlify CLI or linked a site.

See also

Last updated on