Restish Files

Overview

Restish 2.3.0 is a minor release for people building on top of Restish as well as people using it directly from the terminal. It promotes the core config and auth building blocks into public packages, adds a custom embedded command surface for applications that want a Restish-powered CLI, tightens auth header display behavior, and expands the docs and blog around OpenAPI-driven workflows.

Public config and auth packages

The config and auth packages are now available as public API for embedders. Applications can read Restish API registrations, reuse token cache paths, and work with legacy config data without copying internal package behavior.

The migration path is also safer: Restish skips legacy config migration when an explicit config environment is in use, exposes format-agnostic API reading helpers, and includes additional tests around public-package compatibility.

Embedded command surface

Restish now has a custom command surface for embedded CLIs. Projects can build a focused command tree from registered APIs while still leaning on Restish for OpenAPI loading, generated operations, auth handling, and request execution.

The release includes an example embedded CLI, design notes, reference docs, and refreshed promoted-command metadata so applications can choose which Restish commands they expose without pulling in the entire top-level CLI experience.

Safer auth header output

Auth header previewing is more careful in this release. Operation-level auth header printing is aligned with generated command behavior, and cookie-based auth is rejected for header printing so sensitive cookie material does not get displayed as if it were a normal reusable header.

Docs and learning material

The docs gained new material on embedding Restish, OpenAPI-powered command generation, TOON output for compact API data, scripting REST APIs from the shell, and interactive filtering examples. The project maintenance guidance was also refreshed so contributors have clearer validation commands and release checks.

Changelog

• [a1037d] fix(embed): refresh promoted API metadata
• [5649ff] feat(embed): add custom command surface
• [7606e9] docs: publish scripting APIs blog post
• [c0f88b] fix: reject cookie auth header printing
• [7004c7] fix: align operation auth header printing
• [26a317] feat(auth): expose TokenCache.Path() for embedders
• [bcf50d] feat(config): add format-agnostic ReadAPIs helper for embedders
• [082e40] feat: expose embedder helpers for legacy config and auth header
• [0c5d63] fix: skip legacy migration for explicit config env
• [6fa220] fix: address public package review feedback
• [443c4a] fix: tighten public config and auth surface
• [cc5a46] feat: promote config and auth to public packages with embedder convenience layer
• [27c66e] docs: add TOON output blog post
• [caef5e] feat: promote internal/config, internal/auth, internal/fileutil to public packages
• [5db0dd] docs: use full go run command for restish-docgen in CI summary
• [86a500] docs: align docs validation commands with CI and drop unshipped references
• [ca95b2] docs: expand AGENTS.md and refresh agent skills
• [3bebd0] docs: list npm docs-job steps in CI parity guidance
• [1602b5] docs: refresh AGENTS.md and agent skills for accuracy and CI coverage
• [6ae06d] docs: address interactive docs review feedback
• [f8538b] docs: remove docs tag cloud
• [6e5117] docs: add filter trace viewer
• [888d8e] docs: improve interactive guides
• [25ecee] docs: polish interactive examples
• [24a4ed] docs: update blog review guidance
• [9b09e7] docs: add OpenAPI CLI blog post

Full Changelog: https://github.com/rest-sh/restish/compare/v2.2.0...v2.3.0