README
¶
rysh-cli-shared
Shared Go module for Rysh, the agentic terminal multiplexer.
go get github.com/rysh-ai/rysh-cli-shared
| Package | What |
|---|---|
agentic |
the agentic loop — orchestration, grounding, tool dispatch |
provider |
LLM provider adapters and streaming |
msg |
message and channel types shared across the wire |
secretnat |
secret detection and redaction (SecretNAT): outbound values are swapped for stable placeholder tokens and restored on the way back |
tools |
the built-in tool implementations |
bridge |
transport bridge types |
This is a library, not an application. It is consumed by
rysh-cli-code; the packages are
useful on their own but the API is versioned to serve that consumer first.
To work on it against a live CLI checkout, clone
rysh-cli-parent — its go.work
resolves this module to your local tree, so edits are picked up without a release.
Contributing and security
This repository is a one-way export of a tree developed elsewhere, so a commit pushed straight here is overwritten by the next export rather than kept — CONTRIBUTING.md explains where a patch actually lands.
Found a vulnerability? Do not open a public issue, PR or discussion — SECURITY.md has the private channels.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agentic implements the agentic coding assistant actors for use in both the CLI and server contexts.
|
Package agentic implements the agentic coding assistant actors for use in both the CLI and server contexts. |
|
Package bridge provides the NATSBridge that delivers NATS messages to a proto.actor actor mailbox.
|
Package bridge provides the NATSBridge that delivers NATS messages to a proto.actor actor mailbox. |
|
forge
|
|
|
ingest
Package ingest converts source API descriptions into the Forge IR.
|
Package ingest converts source API descriptions into the Forge IR. |
|
ir
Package ir defines the Forge Intermediate Representation: a language- and target-agnostic model of an API.
|
Package ir defines the Forge Intermediate Representation: a language- and target-agnostic model of an API. |
|
runtime
Package runtime is the shared, cross-cutting machinery a generated tool-pack uses at call time: HTTP request assembly, auth injection, retries/backoff, pagination hints, jq-style response trimming, and a secret-redaction hook.
|
Package runtime is the shared, cross-cutting machinery a generated tool-pack uses at call time: HTTP request assembly, auth injection, retries/backoff, pagination hints, jq-style response trimming, and a secret-redaction hook. |
|
toolpack
Package toolpack turns an IR into a hot-loadable Rysh tool pack: a declarative manifest of tool definitions plus the live ToolExecutors that back them.
|
Package toolpack turns an IR into a hot-loadable Rysh tool pack: a declarative manifest of tool definitions plus the live ToolExecutors that back them. |
|
Package mcpclient is a minimal Model Context Protocol (MCP) client for server-side rysh components.
|
Package mcpclient is a minimal Model Context Protocol (MCP) client for server-side rysh components. |
|
Package msg — conversation.go defines the unified ConversationMessage type and related enums.
|
Package msg — conversation.go defines the unified ConversationMessage type and related enums. |
|
Package peercoord defines the versioned, messages-only coordination protocol.
|
Package peercoord defines the versioned, messages-only coordination protocol. |
|
Package provider implements LLM provider interfaces and the Anthropic Messages API client with tool-use support.
|
Package provider implements LLM provider interfaces and the Anthropic Messages API client with tool-use support. |
|
Package secretnat implements SecretNAT — also known by its alias ReSet (Reversible Secret Translation) — a transparent, reversible secret translation layer that sits between rysh and the LLM provider.
|
Package secretnat implements SecretNAT — also known by its alias ReSet (Reversible Secret Translation) — a transparent, reversible secret translation layer that sits between rysh and the LLM provider. |
Click to show internal directories.
Click to hide internal directories.