StackPanel Nix Packages
Documentation for the packages module
This directory contains Nix package definitions for StackPanel's core binaries and libraries. These packages are exposed through the StackPanel flake and can be built or installed using Nix.
Packages
stackpanel-cli
The main command-line interface for StackPanel. Built from the Go source in apps/cli/.
Binary: stackpanel
Features:
- Manage local development services
- Configure Caddy reverse proxy
- Handle SSL certificates
- Control the StackPanel agent
Build:
nix build .#stackpanel-clistackpanel-agent
A background service that enables web UI integration with local development environments. Built from the Go source in apps/agent/.
Binary: stackpanel-agent
Features:
- Bridge between web interface and local services
- Real-time monitoring and control
- WebSocket communication
Build:
nix build .#stackpanel-agentstackpanel-go
A source derivation containing the shared Go module used by both the CLI and agent. This is not a compiled binary - it provides source files for Go module replace directives during builds.
Source: packages/stackpanel-go/
Contains:
- Shared types and interfaces
- State management utilities
- Nix evaluation helpers
Usage
These packages are typically consumed through the StackPanel devenv configuration or flake outputs. You can also build them directly:
# Build all packages
nix build .#stackpanel-cli .#stackpanel-agent
# Enter a shell with packages available
nix develop
# Run directly
nix run .#stackpanel-cli -- --helpAdding New Packages
- Create a new directory:
nix/stackpanel/packages/<package-name>/ - Add a
default.nixwith the package definition - Follow the documentation header format used in existing packages
- Export the package in the appropriate flake output