Documentation
¶
Overview ¶
Package human exposes the two top-level Human framework surfaces.
NewLLM constructs the real-time, response-oriented HumanLLM correctness core. NewAgent constructs the durable, task-oriented HumanAgent core. Both are transport-neutral library objects: listeners, authentication, storage, encryption, worker clients, and user interfaces are explicit adapters owned by the embedding application.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Agent ¶
Agent owns the durable HumanAgent task lifecycle. It does not start a listener or a worker transport; A2A and other transports are adapters over this domain object.
func NewAgent ¶
func NewAgent(ctx context.Context, config AgentConfig) (*Agent, error)
NewAgent opens or recovers the task-oriented HumanAgent surface. ctx controls only this open operation; after NewAgent returns, method contexts and Shutdown own the Agent lifetime. HumanAgent shares message and workspace concepts with HumanLLM, but not completion request, stream, or timeout state.
type AgentConfig ¶
AgentConfig configures the durable, task-oriented HumanAgent surface. Store is required and may be any implementation of agent.Store. NewAgent never chooses a physical driver or creates hidden process-global state.
func DefaultAgentConfig ¶
func DefaultAgentConfig() AgentConfig
DefaultAgentConfig returns the durable Agent defaults without selecting a persistence identity. Set Store before calling NewAgent.
type LLM ¶
LLM is the transport-neutral HumanLLM correctness core. It owns no HTTP listener, authentication system, WebSocket endpoint, terminal UI, or hidden process-global state. Caller and worker transports borrow it through the public llm.CallerEndpoint and llm.WorkerEndpoint ports.
type LLMConfig ¶
LLMConfig composes the real-time HumanLLM core. Store and DeploymentID are deliberately required deployment choices. Every other port can be replaced independently; framework.Resource records whether Human owns or merely borrows each stateful dependency.
func DefaultLLMConfig ¶
func DefaultLLMConfig() LLMConfig
DefaultLLMConfig returns the built-in OpenAI Chat Completions, OpenAI Responses, and Anthropic Messages codecs together with the explicit llm.AdmitAll admission policy. It intentionally leaves Store and DeploymentID unset so an embedder must choose a durable identity explicitly; replace Admission when the deployment needs policy beyond transport authentication. The returned values are fresh and may be replaced or extended.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package a2a exposes the HTTP+JSON binding for the durable HumanAgent surface.
|
Package a2a exposes the HTTP+JSON binding for the durable HumanAgent surface. |
|
Package agent implements the durable, task-oriented HumanAgent surface.
|
Package agent implements the durable, task-oriented HumanAgent surface. |
|
sqlite
Package sqlite provides the official local SQLite adapter for agent.Store.
|
Package sqlite provides the official local SQLite adapter for agent.Store. |
|
workerws
Package workerws implements the official WebSocket adapter for the public HumanAgent WorkerTransport port.
|
Package workerws implements the official WebSocket adapter for the public HumanAgent WorkerTransport port. |
|
workerws/sqlite
Package sqlite provides the official durable SQLite implementation of the Agent remote-worker Journal port.
|
Package sqlite provides the official durable SQLite implementation of the Agent remote-worker Journal port. |
|
cmd
|
|
|
human
command
|
|
|
examples
|
|
|
custom-framework
command
|
|
|
custom-framework/customprotect
Package customprotect demonstrates an application-owned protect.Protector adapter.
|
Package customprotect demonstrates an application-owned protect.Protector adapter. |
|
custom-framework/customstore
Package customstore demonstrates two application-owned llm.Store adapters: a durable single-file Store opened with Open, and an optional policy middleware opened with Own or Borrow.
|
Package customstore demonstrates two application-owned llm.Store adapters: a durable single-file Store opened with Open, and an optional policy middleware opened with Own or Borrow. |
|
embed-a2a
command
Command embed-a2a demonstrates mounting HumanAgent's A2A 1.0 HTTP+JSON caller surface inside an application-owned router.
|
Command embed-a2a demonstrates mounting HumanAgent's A2A 1.0 HTTP+JSON caller surface inside an application-owned router. |
|
embed-agent
command
Command embed-agent demonstrates the durable HumanAgent domain facade.
|
Command embed-agent demonstrates the durable HumanAgent domain facade. |
|
embed-gateway
command
Command embed-gateway demonstrates mounting Human's model and worker handlers in an application's HTTP server with application-owned identity and tenant-to-worker routing.
|
Command embed-gateway demonstrates mounting Human's model and worker handlers in an application's HTTP server with application-owned identity and tenant-to-worker routing. |
|
embed-local
command
Command embed-local starts a complete Human instance inside another Go process: loopback model API, SQLite service, worker, and browser human side.
|
Command embed-local starts a complete Human instance inside another Go process: loopback model API, SQLite service, worker, and browser human side. |
|
Package framework contains the small cross-surface contracts used to compose HumanLLM and HumanAgent without hiding resource ownership.
|
Package framework contains the small cross-surface contracts used to compose HumanLLM and HumanAgent without hiding resource ownership. |
|
Package gateway provides an embeddable Human Agent model gateway.
|
Package gateway provides an embeddable Human Agent model gateway. |
|
Package humantest provides reusable black-box conformance suites for Human framework ports.
|
Package humantest provides reusable black-box conformance suites for Human framework ports. |
|
internal
|
|
|
auth
Package auth issues and verifies caller API tokens without storing secrets.
|
Package auth issues and verifies caller API tokens without storing secrets. |
|
buildinfo
Package buildinfo exposes release metadata injected by the build pipeline.
|
Package buildinfo exposes release metadata injected by the build pipeline. |
|
callerfs
Package callerfs enforces the caller-side filesystem boundary and CAS edits.
|
Package callerfs enforces the caller-side filesystem boundary and CAS edits. |
|
callershim
Package callershim provides the demand-side execution boundary for the project-owned completion-mode harness adapter.
|
Package callershim provides the demand-side execution boundary for the project-owned completion-mode harness adapter. |
|
completion/adapter
Package adapter contains explicit, versioned harness capability profiles.
|
Package adapter contains explicit, versioned harness capability profiles. |
|
completion/canonical
Package canonical defines the dialect-neutral model used by completion APIs.
|
Package canonical defines the dialect-neutral model used by completion APIs. |
|
completion/dialect
Package dialect defines the pure wire-codec boundary for model APIs.
|
Package dialect defines the pure wire-codec boundary for model APIs. |
|
completion/dialect/anthropic
Package anthropic implements the Anthropic Messages wire dialect.
|
Package anthropic implements the Anthropic Messages wire dialect. |
|
completion/dialect/openai
Package openai implements the OpenAI Chat Completions wire dialect.
|
Package openai implements the OpenAI Chat Completions wire dialect. |
|
completion/dialect/responses
Package responses implements the OpenAI Responses API wire dialect.
|
Package responses implements the OpenAI Responses API wire dialect. |
|
completion/gateway
Package gateway implements the synchronous, model-compatible completion gateway.
|
Package gateway implements the synchronous, model-compatible completion gateway. |
|
completion/hub
Package hub provides the in-process worker queue used by gateway.
|
Package hub provides the in-process worker queue used by gateway. |
|
completion/safety
Package safety implements gateway-side lexical defense and warning labels.
|
Package safety implements gateway-side lexical defense and warning labels. |
|
gatewaycmd
Package gatewaycmd assembles the standalone gateway and administration CLI.
|
Package gatewaycmd assembles the standalone gateway and administration CLI. |
|
humancmd
Package humancmd assembles the human worker TUI command.
|
Package humancmd assembles the human worker TUI command. |
|
mirror
Package mirror manages the worker-side scratch copy used by completion mode.
|
Package mirror manages the worker-side scratch copy used by completion mode. |
|
ownerlock
Package ownerlock provides a process-lifetime, cross-process ownership lock for a canonical file-backed SQLite location.
|
Package ownerlock provides a process-lifetime, cross-process ownership lock for a canonical file-backed SQLite location. |
|
ratelimit
Package ratelimit provides an in-memory, per-key admission limiter.
|
Package ratelimit provides an in-memory, per-key admission limiter. |
|
sqlitefile
Package sqlitefile secures file-backed SQLite databases before a driver opens them.
|
Package sqlitefile secures file-backed SQLite databases before a driver opens them. |
|
store
Package store defines persistence contracts for completion requests.
|
Package store defines persistence contracts for completion requests. |
|
store/sqlite
Package sqlite implements the shared Store contracts using pure-Go SQLite.
|
Package sqlite implements the shared Store contracts using pure-Go SQLite. |
|
userdata
Package userdata resolves Human's private, per-user durable state.
|
Package userdata resolves Human's private, per-user durable state. |
|
workerbridge
Package workerbridge adapts the frozen legacy worker WebSocket client to the public workerkit.Wire port, so the shipped products (human local, human worker) can run the web human side against the existing gateway while the caller half of dual-stack convergence is still pending.
|
Package workerbridge adapts the frozen legacy worker WebSocket client to the public workerkit.Wire port, so the shipped products (human local, human worker) can run the web human side against the existing gateway while the caller half of dual-stack convergence is still pending. |
|
workerclient
Package workerclient implements the human TUI side of the private worker WS.
|
Package workerclient implements the human TUI side of the private worker WS. |
|
workerproto
Package workerproto defines the private, versioned gateway-to-TUI protocol.
|
Package workerproto defines the private, versioned gateway-to-TUI protocol. |
|
workerstate
Package workerstate persists worker-side UI state that must survive a disconnect or process restart.
|
Package workerstate persists worker-side UI state that must survive a disconnect or process restart. |
|
workerws
Package workerws exposes the private WebSocket transport used by human TUI.
|
Package workerws exposes the private WebSocket transport used by human TUI. |
|
Package llm defines the public, dialect-neutral contracts used by HumanLLM.
|
Package llm defines the public, dialect-neutral contracts used by HumanLLM. |
|
builtin
Package builtin exposes HumanLLM's built-in model-API codecs through the public llm.Codec port.
|
Package builtin exposes HumanLLM's built-in model-API codecs through the public llm.Codec port. |
|
callerhttp
Package callerhttp provides the official HTTP caller transport for HumanLLM.
|
Package callerhttp provides the official HTTP caller transport for HumanLLM. |
|
callerhttp/bearerauth
Package bearerauth is HumanLLM's basic caller Authenticator: it accepts a single shared token using the OpenAI Authorization bearer convention or the Anthropic X-Api-Key convention, and attributes every accepted request to one fixed CallerID.
|
Package bearerauth is HumanLLM's basic caller Authenticator: it accepts a single shared token using the OpenAI Authorization bearer convention or the Anthropic X-Api-Key convention, and attributes every accepted request to one fixed CallerID. |
|
callerhttp/harnessresolver
Package harnessresolver is HumanLLM's basic caller-side RequestResolver: it maps the exact session identity emitted by recognized coding harnesses onto the transport-neutral llm.TaskContext, and derives a stable idempotency key for a harness turn so a dropped-socket retry dedups instead of forking work.
|
Package harnessresolver is HumanLLM's basic caller-side RequestResolver: it maps the exact session identity emitted by recognized coding harnesses onto the transport-neutral llm.TaskContext, and derives a stable idempotency key for a harness turn so a dropped-socket retry dedups instead of forking work. |
|
sqlite
Package sqlite is HumanLLM's official single-process SQLite Store adapter.
|
Package sqlite is HumanLLM's official single-process SQLite Store adapter. |
|
workerws
Package workerws implements the official WebSocket adapter for the public HumanLLM WorkerTransport port.
|
Package workerws implements the official WebSocket adapter for the public HumanLLM WorkerTransport port. |
|
workerws/sqlite
Package sqlite provides the official durable SQLite implementation of the HumanLLM remote-worker Journal port.
|
Package sqlite provides the official durable SQLite implementation of the HumanLLM remote-worker Journal port. |
|
Package local runs the batteries-included HumanLLM desktop composition in one process: a loopback caller endpoint, an SQLite-backed llm.Service, and a browser human side connected in-process through workerkit.
|
Package local runs the batteries-included HumanLLM desktop composition in one process: a loopback caller endpoint, an SQLite-backed llm.Service, and a browser human side connected in-process through workerkit. |
|
Package observe defines the shared observability port for Human runtimes.
|
Package observe defines the shared observability port for Human runtimes. |
|
Package protect defines the provider-neutral payload protection port used by Human runtimes.
|
Package protect defines the provider-neutral payload protection port used by Human runtimes. |
|
aead
Package aead provides Human's local, in-memory AES-256-GCM Protector.
|
Package aead provides Human's local, in-memory AES-256-GCM Protector. |
|
Package web is the official browser UI for the Human worker.
|
Package web is the official browser UI for the Human worker. |
|
Package workerkit is the headless human-side domain layer of HumanLLM.
|
Package workerkit is the headless human-side domain layer of HumanLLM. |
|
fsmirror
Package fsmirror is the official filesystem Mirror adapter for workerkit.
|
Package fsmirror is the official filesystem Mirror adapter for workerkit. |
|
sqlite
Package sqlite provides the official durable SQLite implementation of the workerkit StateStore port.
|
Package sqlite provides the official durable SQLite implementation of the workerkit StateStore port. |
|
Package workspace contains transport-neutral identities and the replaceable caller-side Store used to apply HumanAgent artifacts.
|
Package workspace contains transport-neutral identities and the replaceable caller-side Store used to apply HumanAgent artifacts. |
|
sqlite
Package sqlite provides the official single-owner SQLite implementation of workspace.Store.
|
Package sqlite provides the official single-owner SQLite implementation of workspace.Store. |

