Installation

Run Loopwright as a zero-install GitHub Action in target repositories or install the @gpustack/loopwright CLI on a macOS or Linux laptop. After setup, paste a single bootstrap prompt into your coding agent to initialize or migrate repository configuration interactively.

Contents

• Entry points
• Prerequisites
• Step 1: Install CLI
• Step 2: Verify CLI
• GitHub Actions
• Prompt bootstrap

Entry points

Prerequisites

Local CLI and app-serve hosts must satisfy the runtime baseline : Node.js 26.x (with built-in node:sqlite), npm 11.x, and a local POSIX filesystem on darwin/arm64, linux/arm64, or linux/x64. Provision an approved sandbox backend before executing isolated agent steps.

Step 1: Install CLI

npm package

Install the single-package CLI globally from npmjs.com using npm or pnpm (--ignore-scripts skips optional transitive lifecycle scripts required by pnpm v10+ build hygiene):

npm install -g --ignore-scripts @gpustack/loopwright
# or with pnpm:
pnpm add -g --ignore-scripts @gpustack/loopwright

To run one-off commands without a global install, invoke npx or pnpm dlx:

npx --ignore-scripts @gpustack/loopwright --help
# or with pnpm:
pnpm --ignore-scripts dlx @gpustack/loopwright --help

Release archive

Install an immutable release archive directly from GitHub Releases (replace 0.1.0 with the published version):

npm install -g --ignore-scripts https://github.com/gpustack/loopwright/releases/download/v0.1.0/gpustack-loopwright-0.1.0.tgz

Source build

Clone the repository to develop locally or test unreleased commits:

git clone https://github.com/gpustack/loopwright.git
cd loopwright
npm ci
npm run build
npm link

Step 2: Verify CLI

Confirm the binary resolves on your PATH:

loopwright --version
loopwright --help

For Managed Controller runs, loopwright init --directory "$HOME/loopwright-ops" writes low-level controller.draft.yaml and registry.draft.yaml skeletons (0600). To initialize a repository .loopwright/taskpack.yaml or migrate existing sync scripts without manual boilerplate, use the interactive bootstrap prompt below.

GitHub Actions

Consumer repositories using Declarative Taskpack mode do not need local CLI installation. Add .loopwright/taskpack.yaml and reference gpustack/loopwright@main in .github/workflows/loopwright.yml:

name: loopwright
on:
  workflow_dispatch: {}
permissions:
  contents: read
jobs:
  taskpack:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: gpustack/loopwright@main
        with:
          taskpack-path: .loopwright/taskpack.yaml
          event-name: ${{ github.event_name }}
          event-path: ${{ github.event_path }}
          dry-run: 'true'

The composite Action provisions Node.js 26 automatically on the runner. Follow GitHub Action for App token wiring and secret bindings.

Prompt bootstrap

No custom skill or plugin is required to author Loopwright YAML. Open your coding agent inside the target repository (for example, when migrating an existing automatic synchronized workflow) and paste one prompt:

Taskpack prompt

Read https://docs.gpustack.ai/loopwright/llms.txt and fetch the Markdown guides for Declarative Taskpack, Taskpack, and GitHub Action. Inspect this repository (including any existing automatic synchronized workflows, scripts, version tables, and directory layout), confirm my upstream sources, writable/protected paths, verification checks, and PR settings with me, then generate .loopwright/taskpack.yaml and .github/workflows/loopwright.yml (apiVersion: loopwright.dev/v1alpha1) without hardcoding secrets.

Controller prompt

Read https://docs.gpustack.ai/loopwright/llms.txt and fetch the Markdown guides for Managed Controller, Task Contract, and Controller and Registry. Help me design an out-of-repo TrustedRegistry (registry.yaml) and SHA-256-pinned ControllerConfig (controller.yaml) for this repository, compute the local Loopwright handler and graph digests, and verify the plan with loopwright check.