> ## Documentation Index
> Fetch the complete documentation index at: https://www.shipfox.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Shipfox: Agentic Workflows for Engineering Teams

> Shipfox is a continuous shipping platform. Define YAML workflows in your repo, run shell and AI agent steps, and trigger pipelines from the tools you already use.

Shipfox is a continuous shipping platform where **any step in a workflow can be an AI agent** — one that reads your repository, runs tools, and acts, with its reasoning streamed live — right beside the shell commands, triggers, and runners you'd expect. Workflows are YAML in your repo, and agent steps share the same lifecycle as shell steps: they stream output, report status, and can be gated and retried until the result is correct. This documentation covers everything from connecting your first project to authoring agentic pipelines that fix code and verify themselves.

<CardGroup cols={2}>
  <Card title="Get Started" icon="rocket" href="/getting-started">
    Connect your first project and run a workflow in minutes.
  </Card>
</CardGroup>

## What is Shipfox?

Workflows live in `.shipfox/workflows/` as YAML files, versioned and reviewed alongside the rest of your code. A trigger — such as a GitHub push, a Sentry alert, or an on-demand call — starts a run. Each run is composed of jobs, which are logical groups of steps. A step is either a `run` command (plain shell) or an agent step that pairs a `model` with a `prompt`. AI agents are first-class citizens in Shipfox, not an afterthought bolted on later — any step in any job can invoke an AI model from 30+ supported providers.

## Why Shipfox is different

Three things set Shipfox apart, and they compound:

* **Agents are first-class steps.** Any step can be an AI agent — pick a `model`, write a `prompt`, choose a `thinking` depth. No plugin, no action, no glue.
* **Agents iterate until the work is correct.** Pair an agent with a [gate](/concepts/gates): the agent makes a change, a `run` step verifies it, and `restart_from` loops back to the agent until the check passes — bounded automatically.
* **You see the agent think.** Agent steps stream structured events — messages, thinking, tool calls, token usage, and cost — not just raw text.

```yaml theme={null}
jobs:
  fix:
    steps:
      - key: edit
        model: claude-opus-4-8
        prompt: Fix the failing unit tests in this repository.
      - run: npm test
        gate:
          success_if: exit_code == 0
          on_failure:
            restart_from: edit   # the agent tries again until tests pass
```

## Key features

<CardGroup cols={2}>
  <Card title="YAML Workflows in Your Repo" icon="code-branch" href="/concepts/workflows">
    Workflows live under `.shipfox/workflows/`, versioned and reviewed like any code.
  </Card>

  <Card title="AI Agent Steps" icon="robot" href="/concepts/jobs-steps">
    Any step can run an AI agent: pick a model, write a prompt, and Shipfox does the rest.
  </Card>

  <Card title="Gates & Retry Loops" icon="rotate" href="/concepts/gates">
    Gate a step on its exit code and `restart_from` an earlier step — bounded loops, no scripting.
  </Card>

  <Card title="Live & Agent Logs" icon="terminal" href="/concepts/logging">
    Tail every step live; agent steps show messages, thinking, and tool calls as structured events.
  </Card>

  <Card title="Your Own Runners" icon="server" href="/concepts/runners">
    Jobs execute on runners you register and control — no vendor lock-in on compute.
  </Card>

  <Card title="Autoscaling Provisioners" icon="layer-group" href="/concepts/runner-provisioners">
    A provisioner starts ephemeral, single-job runners on demand and lets them exit when idle.
  </Card>

  <Card title="Smart Triggers" icon="bolt" href="/integrations/overview">
    GitHub pushes, Sentry issues, webhooks from any system, or on-demand fire — with more integrations on the way.
  </Card>

  <Card title="30+ Model Providers" icon="sparkles" href="/reference/model-providers">
    Anthropic, OpenAI, DeepSeek, xAI, Google, Mistral, and more.
  </Card>
</CardGroup>

## Quickstart

<Steps>
  <Step title="Connect your project">
    In your workspace, create a project and connect a Git repository. Shipfox will watch the repo for the triggers you configure in your workflow files.
  </Step>

  <Step title="Add a workflow file">
    Create `.shipfox/workflows/hello.yml` in your repository with the following minimal workflow:

    ```yaml theme={null}
    name: Hello world
    runner: ubuntu-latest
    triggers:
      on_demand:
        source: manual
        event: fire
    jobs:
      build:
        steps:
          - run: echo "hello world"
    ```
  </Step>

  <Step title="Register a runner">
    Generate a registration token in the Shipfox dashboard, then start a runner on your own infrastructure using the matching label. The runner will connect and begin polling for jobs.
  </Step>

  <Step title="Fire your first run">
    Trigger the workflow by clicking **Run** next to it in the dashboard, or push a commit to your connected repository. Watch the run execute live in the Shipfox UI.
  </Step>
</Steps>

<Note>
  These docs are AI-ingestible — every page is available as Markdown, so your coding agent can author workflows for you.
</Note>