Skip to content

docs: SDK ergonomics for Praefectus - #52

Merged
undivisible merged 1 commit into
mainfrom
chore/sdk-ergonomics-praefectus
Sep 11, 2026
Merged

docs: SDK ergonomics for Praefectus#52
undivisible merged 1 commit into
mainfrom
chore/sdk-ergonomics-praefectus

Conversation

@undivisible

@undivisible undivisible commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Lead the README with a one-line pitch and a runnable Quick Start before the protocol essay, add AGENTS.md for layout and non-invented APIs, and ship a credential-free library example.

Changes

  • README: one-line pitch + ## Quick Start (cargo build / cargo test, capabilities / surfaces / status, cargo run --example capabilities) before the trust-model and protocol essay. Existing CLI/library/protocol text is unchanged aside from the new top matter and a Development example command. The stale 0.7.0 version label is dropped so the crate version in Cargo.toml stays the source of truth.
  • AGENTS.md: layout, build/test gates, CLI vs library paths, and what not to invent (no fake execute CLI, no secrets, no remote CDP, no host approval ledgers).
  • examples/: capabilities.rs constructs Engine with NativeExecutor and DenyAuthority, prints capabilities, and reads status for a missing operation ID. examples/README.md follows the equilibrium name / run / Demonstrates layout.
  • Cargo.toml: [[example]] plus /examples/** in include.

No runtime behavior changes.

Verification

Ran on this branch:

  • cargo fmt --all -- --check
  • cargo clippy --all-targets --all-features -- -D warnings
  • cargo clippy --all-targets -- -D warnings
  • cargo check --all-targets --all-features
  • cargo test --all-features (one pre-existing env failure, see below)
  • cargo run --example capabilitiesplatform=linux backend=praefectus-linux status=none
  • cargo run -- capabilitiesok: true
  • cargo run -- surfacesobservation_error / exit 3 (no AT-SPI desktop)
  • cargo run -- status --ledger ./operations.jsonl example-missing-operation{"data":null,"ok":true}
  • cargo package --list includes examples/capabilities.rs and examples/README.md

native_executor_routes_coordinate_effects fails on this agent VM because DISPLAY=:1 is set, so the Linux early-return does not apply, move is advertised, and global input is refused as NoEffect. That assertion is unchanged on main and is outside this docs-only PR. GitHub Actions Ubuntu has no DISPLAY/WAYLAND_DISPLAY and skips that path.

Open in Web Open in Cursor 

Lead the README with a one-line pitch and runnable Quick Start before the
protocol essay, add an agent layout guide, and ship a credential-free
library example that prints capabilities and missing-operation status.

Co-authored-by: Max Carter 祁明思 <max@tsc.hk>
@undivisible
undivisible marked this pull request as ready for review September 11, 2026 19:21
@cursor

cursor Bot commented Sep 11, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_b0ca9f84-a95d-4861-aeab-34138048254d)

@undivisible
undivisible merged commit 6b362a7 into main Sep 11, 2026
13 checks passed
@undivisible
undivisible deleted the chore/sdk-ergonomics-praefectus branch September 11, 2026 19:25
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.

2 participants