Documentation
ΒΆ
Overview ΒΆ
Command proximo is a local development reverse proxy that makes any running Docker container reachable at https://<name>.<tld> with automatic DNS and trusted HTTPS, on macOS and Linux.
Directories
ΒΆ
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
dnsserver
command
Command dnsserver is the wildcard DNS server that runs inside the proximo stack.
|
Command dnsserver is the wildcard DNS server that runs inside the proximo stack. |
|
inspector
command
Command inspector is the proximo hop that serves routes under Inspection.
|
Command inspector is the proximo hop that serves routes under Inspection. |
|
peerrelay
command
Command peerrelay is the peer relay: it accepts TCP on this machine's mesh address and copies every connection, byte for byte, to Traefik's websecure entrypoint over the Stack network.
|
Command peerrelay is the peer relay: it accepts TCP on this machine's mesh address and copies every connection, byte for byte, to Traefik's websecure entrypoint over the Stack network. |
|
watcher
command
Command watcher runs inside the proximo stack and keeps the Traefik container attached to the Docker networks of routed containers across their lifecycle.
|
Command watcher runs inside the proximo stack and keeps the Traefik container attached to the Docker networks of routed containers across their lifecycle. |
|
hack
|
|
|
nameconstraints
command
Command nameconstraints mints the X.509 name-constraint fixtures that the "Two machines, proved by hand" proof needs, serves them over TLS so a real browser can be pointed at them, and verifies them with Go's own crypto/x509.
|
Command nameconstraints mints the X.509 name-constraint fixtures that the "Two machines, proved by hand" proof needs, serves them over TLS so a real browser can be pointed at them, and verifies them with Go's own crypto/x509. |
|
internal
|
|
|
checks
Package checks verifies the environment proximo needs, one independently verifiable statement at a time, and collects the outcomes into one Report.
|
Package checks verifies the environment proximo needs, one independently verifiable statement at a time, and collects the outcomes into one Report. |
|
cli
Package cli implements the proximo command surface.
|
Package cli implements the proximo command surface. |
|
config
Package config manages proximo's persisted user configuration and the on-disk paths it uses (TLS material, the embedded stack, etc.).
|
Package config manages proximo's persisted user configuration and the on-disk paths it uses (TLS material, the embedded stack, etc.). |
|
dns
Package dns implements the wildcard DNS server and the host-resolver wiring that route the configured TLD to the local proximo.
|
Package dns implements the wildcard DNS server and the host-resolver wiring that route the configured TLD to the local proximo. |
|
docker
Package docker materializes and drives the embedded reverse-proxy stack (Traefik + DNS server + network watcher) via `docker compose`, and hosts the network-attach watcher used inside the stack.
|
Package docker materializes and drives the embedded reverse-proxy stack (Traefik + DNS server + network watcher) via `docker compose`, and hosts the network-attach watcher used inside the stack. |
|
inspect
Package inspect implements the proximo hop that sits in front of routes under Inspection: it proxies to the backend, injects the reporting agent into HTML responses, ingests what the agent sends back, and keeps the resulting Exchanges in memory.
|
Package inspect implements the proximo hop that sits in front of routes under Inspection: it proxies to the backend, injects the reporting agent into HTML responses, ingests what the agent sends back, and keeps the resulting Exchanges in memory. |
|
observability
Package observability bootstraps the opt-in dev-time observability stack (Dozzle logs + Beszel metrics hub/agent).
|
Package observability bootstraps the opt-in dev-time observability stack (Dozzle logs + Beszel metrics hub/agent). |
|
platform
Package platform provides OS / package-manager detection and the small set of privileged and unprivileged host operations the CLI relies on.
|
Package platform provides OS / package-manager detection and the small set of privileged and unprivileged host operations the CLI relies on. |
|
skill
Package skill installs the agent Skill proximo ships, and reports how every installed copy stands against the binary that would write it.
|
Package skill installs the agent Skill proximo ships, and reports how every installed copy stands against the binary that would write it. |
|
tls
Package tls generates the local CA and wildcard certificate (via crypto/x509) and installs/removes trust in the system and NSS stores.
|
Package tls generates the local CA and wildcard certificate (via crypto/x509) and installs/removes trust in the system and NSS stores. |
|
transcript
Package transcript reads back what a Project's own container wrote while an Exchange was live.
|
Package transcript reads back what a Project's own container wrote while an Exchange was live. |
|
version
Package version holds build metadata injected at release time via -ldflags.
|
Package version holds build metadata injected at release time via -ldflags. |
|
Package skills holds what proximo publishes to coding agents.
|
Package skills holds what proximo publishes to coding agents. |
|
tools
|
|
|
team-ca
command
Command team-ca is the custodian's half of the peer-sharing ceremony (docs/sharing.md#the-team-root-and-the-intermediates).
|
Command team-ca is the custodian's half of the peer-sharing ceremony (docs/sharing.md#the-team-root-and-the-intermediates). |
Click to show internal directories.
Click to hide internal directories.