Skip to content

docs(hosted): guide private remote runs - #1019

Merged
mkceichelbeck merged 1 commit into
mainfrom
codex/private-hosted-guidance
Aug 14, 2026
Merged

docs(hosted): guide private remote runs#1019
mkceichelbeck merged 1 commit into
mainfrom
codex/private-hosted-guidance

Conversation

@mkceichelbeck

Copy link
Copy Markdown
Contributor

Summary

  • add concise candidate-only target, setup, and remote-run CLI help
  • include a private guide and complete hosted examples for built-in and custom coordinators
  • use provider, harness, and model consistently at the user-facing runtime boundary
  • package and validate the guide and examples without changing the public npm artifact
  • make uncertain-submission retry requirements explicit and payload-safe

Verification

  • npm run test:hosted (59 private-candidate tests, 44 hosted-target tests)
  • packed tarball global install, installed guide/example copy, and CLI launch
  • npm run check (typecheck and lint; no errors)
  • staged Opcore policy gate
  • independent newcomer, information-boundary, and technical reviews

The candidate remains unpublished and private. Normal Zeroshot npm packing excludes the private candidate, guide, examples, and tests.

@greptile-apps

greptile-apps Bot commented Aug 14, 2026

Copy link
Copy Markdown

Greptile Summary

The PR documents and packages the unpublished hosted CLI candidate while renaming its user-facing runtime selector from executable to harness.

  • Adds a private remote-run guide, concise CLI help, and complete graph, input, cluster, and provider examples.
  • Packages the guidance files into the candidate tarball without adding them to the public npm artifact.
  • Preserves the capsule-facing executable payload while exposing harness in local runtime configuration.
  • Clarifies idempotent retry requirements for submissions with uncertain outcomes.

Confidence Score: 5/5

The PR appears safe to merge with no actionable correctness, packaging, or security defects identified.

The candidate package preserves its downstream runtime contract, installs guidance at the documented location, keeps private assets out of the public artifact, and aligns the new examples and help text with current validation behavior.

Important Files Changed

Filename Overview
private/hosted-cli-candidate/runtime-config.js Renames the local runtime selector to harness while preserving the capsule-facing executable field during bundle resolution.
private/hosted-cli-candidate/build-candidate.js Adds the guide, examples, and help module to the private candidate package and creates parent directories for nested files.
private/hosted-cli-candidate/register.js Adds contextual help for target setup and hosted runs without changing the established validation boundary.
private/hosted-cli-candidate/README.md Provides an end-to-end guide for candidate installation, target setup, remote execution, custom clusters, and retry recovery.
private/hosted-cli-candidate/default-run-intent-services.js Expands uncertain-submission errors to state the exact payload-stability requirements for safe idempotent retries.
tests/private-hosted-cli/package-isolation.test.js Verifies that private guidance is included in the candidate package while remaining excluded from the public artifact.
tests/private-hosted-cli/guidance.test.js Validates the packaged guidance and examples against the candidate’s runtime and command contracts.

Sequence Diagram

sequenceDiagram
  participant User
  participant CLI as Private candidate CLI
  participant Config as Local runtime config
  participant Target as Hosted target
  participant Capsule as Hosted capsule
  User->>CLI: target setup --runtime-config
  CLI->>CLI: Store absolute config path
  User->>CLI: run --target --graph --input --ship
  CLI->>Config: Re-read provider, harness, model, and references
  Config-->>CLI: Resolved runtime bundle
  CLI->>CLI: Map harness to executable
  CLI->>Target: Submit RunIntent with idempotency key
  Target->>Capsule: Start bounded delivery job
  Capsule-->>Target: Status and result
  Target-->>CLI: RunIntent observations
  CLI-->>User: Result or resume command
Loading

Reviews (1): Last reviewed commit: "docs(hosted): guide private remote runs" | Re-trigger Greptile

@mkceichelbeck
mkceichelbeck added this pull request to the merge queue Aug 14, 2026
Merged via the queue into main with commit c47285c Aug 14, 2026
17 of 19 checks passed
@mkceichelbeck
mkceichelbeck deleted the codex/private-hosted-guidance branch August 14, 2026 10:48
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 6.40.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant