crpc-go

module
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2026 License: MIT

README

CellsWeb RPC Go

Native Go RPC functions, schemas, middleware, fasthttp/net-http adapters, multipart intake, Unix IPC and server-rendered documentation.

Install the versioned SDK and CLI

github.com/CellsWeb/crpc-go@v1.0.2 includes the hardening, documentation parity, explicit HTTP null and standalone scaffold fixes. Use Go>=1.27.4:

go install github.com/CellsWeb/crpc-go/cmd/crpc-go@v1.0.2
crpc-go version
crpc-go init my-api
cd my-api
go mod tidy
go build ./...
go test ./...
crpc-go dev

Put GOBIN (or $(go env GOPATH)/bin) on PATH. The versioned CLI generates a matching SDK v1.0.2 dependency without a workspace or local replacement. For an existing module: go get github.com/CellsWeb/crpc-go@v1.0.2.

Source/VCS-built CLIs still intentionally select the older v1.0.0 SDK fallback; use an explicit workspace when testing local SDK changes. The CLI display version alone does not identify its generated dependency. See installation and migration.

Contracts

HTTP POST /rpc accepts {namespace,functionName,data}. Objects, arrays, scalars and explicit null retain shape through validation; omitted HTTP data defaults to {}. Success/error envelopes and default HTTP 200 application-error behavior are shared logically with Node. Native schema vocabularies/error details are not identical. Standard HTTP mapping remains opt-in.

Middleware owns authentication and authorization for HTTP, in-memory and IPC. Remote callers cannot bypass it or establish identity by injecting context. Generated middleware is a customization stub, not an identity provider. Metadata IsPublic is deprecated and ignored; it controls neither docs nor auth. Docs are globally configured. Their middleware schema views never render live configured option values/defaults.

Guides and validation

go build ./...
CRPC_STANDALONE_INTEGRATION=1 go test -count=1 ./...
CRPC_STANDALONE_INTEGRATION=1 CRPC_SCAFFOLD_RACE=1 go test -race -count=1 ./...
go vet ./...

The Node example has a separate npm build/typecheck/IPC suite. The coordinated release plan lives in the sibling Node repository's RELEASE.md. No zero-memory, universal latency or security certification is implied by benchmark fixtures.

Contribute

Read CONTRIBUTING.md for setup, focused changes and review. The development guide and source map explain internals and subsystem tests. Please follow the Code of Conduct; report vulnerabilities through the private reporting policy. Licensed under MIT.

Directories

Path Synopsis
cmd
crpc-go command
pkg
rpc

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL