Publish with the Slop Farm CLI

01

Quick start

Requires Node 20+. No global install needed. Use npx every time, or npm i -g slopfarm.

npx -y slopfarm@latest login
npx -y slopfarm@latest init
npx -y slopfarm@latest validate --json
npx -y slopfarm@latest publish --yes --json

1. login: opens a browser approval page with a short code. The publish secret is stored locally; only a hash is saved on the server.
2. init: writes slopfarm.json (safe to commit). Detects a build command and output folder when it can.
3. validate: runs the declared build and checks the static export (entry HTML, size limits, relative assets).
4. publish: creates or updates the project, uploads changed files, verifies storage, and queues the release for moderation.

02

Give this to your agent

One agent-agnostic handoff for setup, validation, and publishing. Agents should always pass --yes and --json. Progress messages go to stderr; one result object goes to stdout.

Set up this repository to publish its static browser game on Slop Farm.

Work from the game repository root. Be agent-agnostic and use only the public Slop Farm CLI through:
npx -y slopfarm@latest

Safety rules:
- Require Node.js 20 or newer. Check node --version first; if it is unavailable or too old, stop and tell me what must be installed.
- Never print, log, paste into chat, or commit SLOPFARM_TOKEN or any credential.
- Never invent a sourceUrl or publish a Git remote. Leave sourceUrl null unless I explicitly provide a public GitHub URL.
- Do not change the game merely to make publishing easier. Fix only genuine build or static-export problems.
- Do not publish until validation passes and I explicitly approve publishing.

Setup:
1. Inspect package.json, the existing build scripts, output directories, and entry HTML. Do not guess when the repository already defines them.
2. Run: npx -y slopfarm@latest whoami --json
3. If login is required, run: npx -y slopfarm@latest login
   This displays a browser approval code. Give me the code/URL and wait for me to authorize it. Never attempt to automate my account login.
4. If slopfarm.json is missing, run: npx -y slopfarm@latest init --yes --agent
5. Review slopfarm.json against https://slopfarm.games/schemas/project.json. Ensure:
   - build.command is the repository's real production build command
   - build.output is the static playable output directory
   - entry points to the start HTML inside that directory, usually index.html
   - title, description, category, tags, and madeWith are accurate
   - capabilities.saves and capabilities.multiplayer describe only features the game actually implements
   - sourceUrl remains null unless I supplied one
6. Keep slopfarm.json and SLOPFARM_AGENT.md safe to commit. Never commit local credentials or build secrets.

Verify:
7. Run: npx -y slopfarm@latest validate --json
8. If validation fails, use the JSON error and repository evidence to fix the actual build/export issue, then validate again.
9. Optionally preview in the production sandbox with: npx -y slopfarm@latest preview
10. Summarize the detected build command, output folder, entry file, capabilities, validation result, and any files changed. Ask for my approval to publish.

Publish only after I approve:
11. Run: npx -y slopfarm@latest publish --yes --json
12. Then run: npx -y slopfarm@latest status --json
13. Report the project ID, release/version, moderation status, and game URL from JSON stdout. Progress output is on stderr. Explain that a new release is reviewed before it becomes live and the currently approved release stays playable while an update waits.

For CI/headless use, SLOPFARM_TOKEN must come from the user's secret store after one interactive login. Do not create, reveal, or persist it yourself.

03

slopfarm.json

The committed contract between your repo and Slop Farm. The CLI only runs build.command and only ships files under build.output.

{
  "$schema": "https://slopfarm.games/schemas/project.json",
  "projectId": null,
  "title": "Block Buster",
  "description": "Break bricks. Don't miss.",
  "category": "Arcade",
  "tags": ["arcade", "casual"],
  "madeWith": ["Codex"],
  "sourceUrl": null,
  "capabilities": {
    "saves": true,
    "multiplayer": { "maxPlayers": 4 }
  },
  "build": {
    "command": "npm run build",
    "output": "dist"
  },
  "entry": "index.html"
}

• projectId

  Stable game id. Left null on first init; the CLI assigns a UUID on first publish and writes it back.

• title / description / category / tags / madeWith

  Catalog metadata shown on the game page after approval.

• sourceUrl

  Optional public GitHub URL only. The CLI never invents or publishes a Git remote.

• capabilities

  Declare cloud saves and/or private room multiplayer. Games use the Slop Farm SDK; no credentials belong in the build.

• build.command

  Exact shell command the CLI runs. Empty string means "already built"; use --no-build to skip.

• build.output

  Relative folder that contains the playable static build (must stay inside the project).

• entry

  Start HTML file inside the output folder (usually index.html).

Full schema: /schemas/project.json

04

Commands

05

Flags & environment

06

What publish actually does

1. 1Runs only the build command from slopfarm.json (unless --no-build).
2. 2Validates the output folder: entry HTML, file count, total size, and relative asset references.
3. 3Creates or resolves the stable projectId, then opens an immutable release.
4. 4Uploads changed files and reuses unchanged objects from the currently approved release when possible.
5. 5Server verifies every object, marks the release ready, and puts it in the moderation queue. Your live approved build stays playable until a moderator promotes the new one.

Prefer the browser ZIP flow? Use Upload. Both paths hit the same /api/v1 release pipeline.