Skip to content

Conversation

@kcmartin
Copy link
Collaborator

  • update Concepts: Services to edit for length/tone/clarity

@github-actions
Copy link

github-actions bot commented Jan 12, 2026

Preview Deployment

Name URL
Preview https://pr-68-superfly-sprites-docs.fly.dev

Commit: 867d824

@github-actions
Copy link

github-actions bot commented Jan 12, 2026

E2E Test Results

❌ Tests failure

Ran against: https://pr-68-superfly-sprites-docs.fly.dev

- Remove `duration=0` claim (doesn't return immediately as stated)
- Update JSON response example to show actual nested structure with
  `state` object containing status, pid, started_at
- Fix LLM integration example: remove non-functional `dir` parameter,
  use shell wrapper pattern instead

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@kylemclaren
Copy link
Collaborator

Documentation Testing & Fixes

I tested every command from the Services documentation against the live API. Most commands work as documented, but I found and fixed three issues:

Fixes Applied (commit f88fdfb)

  1. Removed duration=0 claim - The docs stated "Set duration=0 to return immediately without streaming" but testing showed it still waits ~5 seconds. Updated to recommend omitting the parameter or using a short value like duration=1s.

  2. Updated JSON response example - The example showed a flat structure, but the actual API returns a nested structure with a state object:

    {
      "name": "webapp",
      "cmd": "npm",
      "args": ["start"],
      "needs": ["postgres"],
      "state": {
        "status": "running",
        "pid": 1234,
        "started_at": "2024-01-15T10:30:00Z"
      }
    }
  3. Fixed LLM integration example - The dir parameter doesn't work (commands always run from /home/sprite). Replaced with a shell wrapper pattern that actually works:

    sprite-env curl -X PUT /v1/services/devserver -d '{
      "cmd": "/bin/sh",
      "args": ["-c", "npm run dev"]
    }'

All Tested Commands

Command Result
sprite-env curl -X PUT /v1/services/<name> ✅ Works
Service creation with args ✅ Works
Service creation with needs ✅ Works
?duration=Xs query param ✅ Works
sprite-env services list ✅ Works
sprite-env services get <name> ✅ Works
sprite-env services delete <name> ✅ Works
sprite-env curl -X POST /v1/services/signal ✅ Works
Dev server / Database / Python worker patterns ✅ Work

🤖 Generated with Claude Code

@kcmartin kcmartin marked this pull request as draft January 16, 2026 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants