# nilbuild/slim architecture

> Architecture diagram of the GitHub repository nilbuild/slim, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nilbuild/slim
- Repository: https://github.com/nilbuild/slim

## Overview

Slim is a CLI for HTTPS local domains, path-based routing, and public sharing. Its main flow configures local certificates and ingress, starts a daemon, and serves requests through a reverse proxy to project ports. Other product branches manage project services and custom domains, expose tunnels, and provide inspection and cleanup commands. Some command implementations were not sampled; those nodes reflect documented capabilities, and links are omitted where source evidence was unavailable.

Main entry points: [`internal/config/config.go`](https://github.com/nilbuild/slim/blob/main/internal/config/config.go) (Configuration), [`cmd/start.go`](https://github.com/nilbuild/slim/blob/main/cmd/start.go) (Domain commands), [`internal/setup/setup.go`](https://github.com/nilbuild/slim/blob/main/internal/setup/setup.go) (First-run setup), [`internal/proxy/server.go`](https://github.com/nilbuild/slim/blob/main/internal/proxy/server.go) (HTTPS proxy server)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["CLI workflows"]
  node_commands["Command entry<br/>[root.go]"]
  node_localcommands["Domain commands<br/>[start.go]"]
  node_projectcommands["Project services<br/>[up.go]"]
  node_project["Project config<br/>[project.go]"]
end

subgraph group_local["Local HTTPS"]
  node_config["Configuration<br/>[config.go]"]
  node_setup["First-run setup<br/>[setup.go]"]
  node_certs["Certificate authority<br/>[ca.go]"]
  node_leafcert["Domain certificates<br/>[leaf.go]"]
  node_trust["OS certificate trust<br/>[trust_linux.go]"]
  node_portforward["Port forwarding<br/>[portfwd_darwin.go]"]
  node_daemon["Background daemon<br/>[daemon.go]"]
  node_proxyserver["HTTPS proxy server<br/>[server.go]"]
  node_routing["Domain and path routing<br/>[handler.go]"]
  node_upstream["Local project services"]
  node_storage[("Local state files<br/>[paths.go]")]
end

subgraph group_sharing["Internet sharing"]
  node_sharecommand["Share command<br/>[share.go]"]
  node_tunnel["Tunnel client<br/>[client.go]"]
end

subgraph group_account["Account services"]
  node_domaincommands["Custom domains<br/>[domain.go]"]
  node_slimservice["Slim service"]
  node_auth["CLI authentication<br/>[auth.go]"]
end

subgraph group_ops["Inspection and cleanup"]
  node_inspection["Logs and diagnostics<br/>[doctor.go]"]
  node_doctor["System checks<br/>[doctor.go]"]
  node_cleanup["Stop and uninstall<br/>[uninstall.go]"]
end

node_user(("CLI user"))
node_publicvisitors(("Public visitors"))

node_user -->|"runs commands"| node_commands
node_commands -.->|"dispatches"| node_localcommands
node_localcommands -->|"prepares local ingress"| node_setup
node_setup -->|"generates CA"| node_certs
node_setup -->|"trusts CA"| node_trust
node_setup -->|"enables forwarding"| node_portforward
node_localcommands -->|"configures domains"| node_config
node_localcommands -->|"starts daemon"| node_daemon
node_daemon -->|"loads configuration"| node_config
node_daemon -->|"starts server"| node_proxyserver
node_proxyserver -->|"loads domain routes"| node_config
node_proxyserver -->|"loads domain certificates"| node_leafcert
node_proxyserver -->|"routes requests"| node_routing
node_routing -->|"proxies HTTP"| node_upstream
node_projectcommands -.->|"reads project config"| node_project
node_projectcommands -.->|"starts project services"| node_config
node_user -->|"runs share"| node_sharecommand
node_sharecommand -->|"requires login"| node_auth
node_sharecommand -->|"opens tunnel"| node_tunnel
node_tunnel -->|"connects by WebSocket"| node_slimservice
node_slimservice -.->|"serves public URL"| node_publicvisitors
node_tunnel -->|"forwards requests"| node_upstream
node_domaincommands -->|"requires login"| node_auth
node_domaincommands -->|"manages DNS verification"| node_slimservice
node_user -->|"runs diagnostics"| node_inspection
node_inspection -.->|"runs checks"| node_doctor
node_doctor -->|"checks certificates"| node_certs
node_doctor -->|"checks daemon status"| node_daemon
node_doctor -->|"checks forwarding"| node_portforward
node_cleanup -.->|"removes local setup"| node_config
node_config -->|"uses state paths"| node_storage

click node_commands "https://github.com/nilbuild/slim/blob/main/cmd/root.go"
click node_localcommands "https://github.com/nilbuild/slim/blob/main/cmd/start.go"
click node_projectcommands "https://github.com/nilbuild/slim/blob/main/cmd/up.go"
click node_domaincommands "https://github.com/nilbuild/slim/blob/main/cmd/domain.go"
click node_config "https://github.com/nilbuild/slim/blob/main/internal/config/config.go"
click node_project "https://github.com/nilbuild/slim/blob/main/internal/project/project.go"
click node_setup "https://github.com/nilbuild/slim/blob/main/internal/setup/setup.go"
click node_certs "https://github.com/nilbuild/slim/blob/main/internal/cert/ca.go"
click node_leafcert "https://github.com/nilbuild/slim/blob/main/internal/cert/leaf.go"
click node_trust "https://github.com/nilbuild/slim/blob/main/internal/cert/trust_linux.go"
click node_portforward "https://github.com/nilbuild/slim/blob/main/internal/system/portfwd_darwin.go"
click node_daemon "https://github.com/nilbuild/slim/blob/main/internal/daemon/daemon.go"
click node_proxyserver "https://github.com/nilbuild/slim/blob/main/internal/proxy/server.go"
click node_routing "https://github.com/nilbuild/slim/blob/main/internal/proxy/handler.go"
click node_sharecommand "https://github.com/nilbuild/slim/blob/main/cmd/share.go"
click node_tunnel "https://github.com/nilbuild/slim/blob/main/internal/tunnel/client.go"
click node_auth "https://github.com/nilbuild/slim/blob/main/internal/auth/auth.go"
click node_inspection "https://github.com/nilbuild/slim/blob/main/cmd/doctor.go"
click node_doctor "https://github.com/nilbuild/slim/blob/main/internal/doctor/doctor.go"
click node_cleanup "https://github.com/nilbuild/slim/blob/main/cmd/uninstall.go"
click node_storage "https://github.com/nilbuild/slim/blob/main/internal/config/paths.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_commands,node_localcommands,node_projectcommands,node_project,node_user toneBlue
class node_config,node_setup,node_certs,node_leafcert,node_trust,node_portforward,node_daemon,node_proxyserver,node_routing,node_upstream,node_storage toneAmber
class node_sharecommand,node_tunnel toneMint
class node_domaincommands,node_slimservice,node_auth toneRose
class node_inspection,node_doctor,node_cleanup,node_publicvisitors toneIndigo
```

## Components

### CLI workflows

- [Command entry](https://github.com/nilbuild/slim/blob/main/cmd/root.go): `cmd/root.go`
- [Domain commands](https://github.com/nilbuild/slim/blob/main/cmd/start.go): `cmd/start.go`
- [Project services](https://github.com/nilbuild/slim/blob/main/cmd/up.go): `cmd/up.go`
- [Project config](https://github.com/nilbuild/slim/blob/main/internal/project/project.go): `internal/project/project.go`

### Local HTTPS

- [Configuration](https://github.com/nilbuild/slim/blob/main/internal/config/config.go): `internal/config/config.go`
- [First-run setup](https://github.com/nilbuild/slim/blob/main/internal/setup/setup.go): `internal/setup/setup.go`
- [Certificate authority](https://github.com/nilbuild/slim/blob/main/internal/cert/ca.go): `internal/cert/ca.go`
- [Domain certificates](https://github.com/nilbuild/slim/blob/main/internal/cert/leaf.go): `internal/cert/leaf.go`
- [OS certificate trust](https://github.com/nilbuild/slim/blob/main/internal/cert/trust_linux.go): `internal/cert/trust_linux.go`
- [Port forwarding](https://github.com/nilbuild/slim/blob/main/internal/system/portfwd_darwin.go): `internal/system/portfwd_darwin.go`
- [Background daemon](https://github.com/nilbuild/slim/blob/main/internal/daemon/daemon.go): `internal/daemon/daemon.go`
- [HTTPS proxy server](https://github.com/nilbuild/slim/blob/main/internal/proxy/server.go): `internal/proxy/server.go`
- [Domain and path routing](https://github.com/nilbuild/slim/blob/main/internal/proxy/handler.go): `internal/proxy/handler.go`
- **Local project services**
- [Local state files](https://github.com/nilbuild/slim/blob/main/internal/config/paths.go): `internal/config/paths.go`

### Internet sharing

- [Share command](https://github.com/nilbuild/slim/blob/main/cmd/share.go): `cmd/share.go`
- [Tunnel client](https://github.com/nilbuild/slim/blob/main/internal/tunnel/client.go): `internal/tunnel/client.go`

### Account services

- [Custom domains](https://github.com/nilbuild/slim/blob/main/cmd/domain.go): `cmd/domain.go`
- **Slim service**
- [CLI authentication](https://github.com/nilbuild/slim/blob/main/internal/auth/auth.go): `internal/auth/auth.go`

### Inspection and cleanup

- [Logs and diagnostics](https://github.com/nilbuild/slim/blob/main/cmd/doctor.go): `cmd/doctor.go`
- [System checks](https://github.com/nilbuild/slim/blob/main/internal/doctor/doctor.go): `internal/doctor/doctor.go`
- [Stop and uninstall](https://github.com/nilbuild/slim/blob/main/cmd/uninstall.go): `cmd/uninstall.go`

### Other components

- **CLI user**
- **Public visitors**

## Connections

- CLI user → Command entry: runs commands
- Command entry → Domain commands: dispatches
- Domain commands → First-run setup: prepares local ingress (evidence: `cmd/start.go`)
- First-run setup → Certificate authority: generates CA (evidence: `internal/setup/setup.go`)
- First-run setup → OS certificate trust: trusts CA (evidence: `internal/setup/setup.go`)
- First-run setup → Port forwarding: enables forwarding (evidence: `internal/setup/setup.go`)
- Domain commands → Configuration: configures domains (evidence: `cmd/start.go`)
- Domain commands → Background daemon: starts daemon (evidence: `cmd/start.go`)
- Background daemon → Configuration: loads configuration (evidence: `internal/daemon/daemon.go`)
- Background daemon → HTTPS proxy server: starts server (evidence: `internal/daemon/daemon.go`)
- HTTPS proxy server → Configuration: loads domain routes (evidence: `internal/proxy/server.go`)
- HTTPS proxy server → Domain certificates: loads domain certificates (evidence: `internal/proxy/server.go`)
- HTTPS proxy server → Domain and path routing: routes requests (evidence: `internal/proxy/server.go`)
- Domain and path routing → Local project services: proxies HTTP (evidence: `internal/proxy/handler.go`)
- Project services → Project config: reads project config (evidence: `README.md`)
- Project services → Configuration: starts project services (evidence: `README.md`)
- CLI user → Share command: runs share (evidence: `README.md`)
- Share command → CLI authentication: requires login (evidence: `cmd/share.go`)
- Share command → Tunnel client: opens tunnel (evidence: `cmd/share.go`)
- Tunnel client → Slim service: connects by WebSocket (evidence: `internal/tunnel/client.go`)
- Slim service → Public visitors: serves public URL (evidence: `README.md`)
- Tunnel client → Local project services: forwards requests (evidence: `internal/tunnel/client.go`)
- Custom domains → CLI authentication: requires login (evidence: `cmd/domain.go`)
- Custom domains → Slim service: manages DNS verification (evidence: `cmd/domain.go`)
- CLI user → Logs and diagnostics: runs diagnostics (evidence: `README.md`)
- Logs and diagnostics → System checks: runs checks
- System checks → Certificate authority: checks certificates (evidence: `internal/doctor/doctor.go`)
- System checks → Background daemon: checks daemon status (evidence: `internal/doctor/doctor.go`)
- System checks → Port forwarding: checks forwarding (evidence: `internal/doctor/doctor.go`)
- Stop and uninstall → Configuration: removes local setup (evidence: `README.md`)
- Configuration → Local state files: uses state paths (evidence: `internal/config/config.go`)
