Skip to content

Clarify PowerShell local demo steps#10

Merged
chendbox merged 2 commits into
chendbox:mainfrom
AlexMnrs:docs/windows-quickstart-copy-paste
Jun 29, 2026
Merged

Clarify PowerShell local demo steps#10
chendbox merged 2 commits into
chendbox:mainfrom
AlexMnrs:docs/windows-quickstart-copy-paste

Conversation

@AlexMnrs

Copy link
Copy Markdown
Contributor

Summary

  • Add PowerShell-ready API health checks to the local demo runbook.
  • Show a copy-pasteable CPU-only job submission that captures the returned job id.
  • Recommend curl.exe and --data "@file.json" to avoid PowerShell alias and JSON quoting pitfalls.

Closes #4

Validation

  • Parsed the added PowerShell snippets with System.Management.Automation.Language.Parser.
  • git diff --check.
  • Created a temporary virtual environment, installed .[test], and ran python -m pytest tests/unit -q successfully.

Note

I did not start the Docker Compose stack locally for this docs-only change; the commands mirror the existing README endpoints and checked-in examples/job.sleep.json fixture.

@AlexMnrs AlexMnrs marked this pull request as ready for review June 27, 2026 11:16
@chendbox

Copy link
Copy Markdown
Owner

Thanks Alex for the PowerShell improvements here.

One fix needed: the submit response returns job_id, not id, so the status example should use $job.job_id instead of $job.id.

Suggested change:
curl.exe -sS "http://localhost:8001/v1/jobs/$($job.job_id)"

@AlexMnrs

AlexMnrs commented Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for catching that. I updated the runbook to use the returned job_id in the status request, and adjusted the preceding sentence to match.

@chendbox chendbox merged commit 5549b8c into chendbox:main Jun 29, 2026
3 checks passed
@chendbox

Copy link
Copy Markdown
Owner

Thanks for the update, the PS example looks good now.

@AlexMnrs AlexMnrs deleted the docs/windows-quickstart-copy-paste branch June 29, 2026 20:12
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.

Improve Windows Quickstart Copy-Paste Flow

2 participants