CommunityToolkit.Aspire.Hosting.Perl
📦 CommunityToolkit.Aspire.Hosting.Perl v13.4.0 12 Functions
1 Types
1 types and 0 members
Types
Functions
method
addPerlApi builder Adds a Perl API server resource (e.g., Mojolicious, Dancer2) to the application model. Passes the `daemon` subcommand so HTTP frameworks start a listener.
addPerlApi(resourceName: string, appDirectory: string, scriptName: string): PerlAppResource method
addPerlExecutable builder Adds a Perl executable (compiled binary or PAR-packed application) to the application model. The executable is run directly rather than through the `perl` interpreter.
addPerlExecutable(resourceName: string, appDirectory: string, executablePath: string): PerlAppResource method
addPerlModule builder Adds a Perl module to the application model. The module is executed using `perl -MModule::Name -e "Module::Name->run()"`.
addPerlModule(resourceName: string, appDirectory: string, moduleName: string): PerlAppResource method
addPerlScript builder Adds a Perl script resource (worker, CLI tool, background service) to the application model.
addPerlScript(resourceName: string, appDirectory: string, scriptName: string): PerlAppResource method
withCarton builder Configures the Perl application to use Carton as its package manager. Carton manages dependencies via `cpanfile` and a lock file (`cpanfile.snapshot`), enabling reproducible builds. Use `WithProjectDependencies``1` to run `carton install` at startup.
withCarton(): PerlAppResource method
withCpanMinus builder Configures the Perl application to use cpanm (App::cpanminus) as its package manager instead of the default cpan. Call this before `WithPackage``1` to change how packages are installed.
withCpanMinus(): PerlAppResource method
withLocalLib builder Configures the Perl application to use a local::lib directory for module isolation. Sets `PERL5LIB`, `PERL_LOCAL_LIB_ROOT`, `PERL_MM_OPT`, and `PERL_MB_OPT` environment variables so that modules are resolved from and installed into the local directory.
withLocalLib(path?: string): PerlAppResource method
withPackage builder Adds a Perl package (module) to be installed before the application starts. Uses the configured package manager: cpan by default, or cpanm if `WithCpanMinus``1` was called.
withPackage(packageName: string, force?: boolean, skipTest?: boolean): PerlAppResource method
withPerlbrew builder Configures the Perl application to use a specific perlbrew-managed Perl version.
withPerlbrew(version: string, perlbrewRoot?: string): PerlAppResource method
withPerlbrewEnvironment builder Configures the Perl application to use a specific perlbrew-managed Perl version. This resolves the Perl executable from the perlbrew installation and updates the resource's command and environment variables so that all subsequent operations use the specified Perl version.
withPerlbrewEnvironment(version: string, perlbrewRoot?: string): PerlAppResource method
withPerlCertificateTrust builder Configures certificate trust for the Perl application by setting SSL/TLS environment variables that common Perl HTTP libraries respect. Sets `SSL_CERT_FILE` (IO::Socket::SSL / LWP), `PERL_LWP_SSL_CA_FILE` (LWP::UserAgent), and `MOJO_CA_FILE` (Mojolicious) to the certificate bundle path provided by Aspire.
withPerlCertificateTrust(): PerlAppResource method
withProjectDependencies builder Configures project-level dependency installation for the Perl application. Runs the appropriate install command based on the active package manager: - - If the active package manager is `cpan` (the default), it is automatically switched to `cpanm` since `cpan` does not support `--installdeps`.
withProjectDependencies(cartonDeployment?: boolean): PerlAppResource