Create

Sign in to ReadmeX

or

How we handle your data: Privacy Policy

ReadmeX

Your AI reading companion

What would you like to catch up on?

Pick a briefing, or ask your own question.

Your community and people briefings stay personal to you.

shrt

shrt: shrt tests a backend through chains of API calls.

What problem it solves

Coding agents often need to trace API call chains before testing a backend, while regressions can involve changes spread across earlier calls and later reads. shrt records approved call chains and their responses as baselines so later releases can be replayed and compared. When a response changes, it identifies the affected step, field, and potentially responsible write.

Key features

  • Contract-driven API chains — Contracts describe required fields, value sources, refusals, and write effects. The planner uses them to create call chains that also probe boundary values and invalid requests.

    Source: README

  • Human-approved regression baselines — Passing runs are proposed as safe spots, but approval remains a manual step. Approved response fields form the baseline against which later releases are replayed.

    Source: README

  • Actionable regression evidence — A failing gate reports the changed field, expected and observed values, and the write or read that may be responsible. Detailed verification output preserves the relevant request and response evidence.

    Source: README

  • Agent and manual workflows — Initialization installs an agent skill and supporting documentation for writing contracts and driving the workflow. Every command can also be used directly by a person.

    Source: README

  • Local-target safety checks — Runs are restricted to local addresses unless additional hosts are explicitly allowed. Commands that would call a target refuse before sending the first request when its host is not approved.

    Source: README

Quick start

Copied verbatim from the project's README.

go install github.com/N4darae/shrt/cmd/shrt@latest
shrt version
export API_USER=demo API_PASSWORD=demo-password
shrt init
shrt doctor

Who it may suit

This may suit backend teams and coding agents that need repeatable, contract-based API regression checks. It may also suit maintainers who want agent-assisted workflows without giving up human approval of baselines.

Topics to discuss

  • Which backend behaviors should be represented as contracts, and which are better expressed as explicit assertions?

  • How can baseline approval workflows preserve human oversight while remaining practical in CI?

  • What additional safeguards or reporting would help teams use agent-generated chains confidently?


Written by ReadmeX AI from the project's README, source and public GitHub data; it may contain mistakes.

Read the original README https://github.com/N4darae/shrt#readme

ReadmeX opened this community for a trending project; it is not run by the project. Maintainers can claim it from the community page.

github.comhttps://github.com/N4darae/shrt

Comments

…