pixi

Pixi workspace tooling for Dagger.

Installation

dagger install github.com/ascii-supply-networks/daggerverse/pixi@v0.0.3

Entrypoint

Return Type

Pixi !

Arguments

Name	Type	Default Value	Description
source	Directory	-	Source directory.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \

func (m *MyModule) Example() *dagger.Pixi  {
	return dag.
			Pixi()
}

@function
def example() -> dagger.Pixi:
	return (
		dag.pixi()
	)

@func()
example(): Pixi {
	return dag
		.pixi()
}

Types

WorkspaceSource 🔗

A Pixi workspace rooted at a pixi.lock.

source() 🔗

Source tree containing the workspace and any sibling path dependencies.

Return Type

Directory !

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 source

func (m *MyModule) Example(path string) *dagger.Directory  {
	return dag.
			Pixi().
			Workspace(path).
			Source()
}

@function
def example(path: str) -> dagger.Directory:
	return (
		dag.pixi()
		.workspace(path)
		.source()
	)

@func()
example(path: string): Directory {
	return dag
		.pixi()
		.workspace(path)
		.source()
}

path() 🔗

Workspace root path holding pixi.lock. . for a root workspace.

Return Type

String !

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 path

func (m *MyModule) Example(ctx context.Context, path string) string  {
	return dag.
			Pixi().
			Workspace(path).
			Path(ctx)
}

@function
async def example(path: str) -> str:
	return await (
		dag.pixi()
		.workspace(path)
		.path()
	)

@func()
async example(path: string): Promise<string> {
	return dag
		.pixi()
		.workspace(path)
		.path()
}

environments() 🔗

Pixi environments declared by the workspace manifest.

Return Type

[String ! ] !

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 environments

func (m *MyModule) Example(ctx context.Context, path string) []string  {
	return dag.
			Pixi().
			Workspace(path).
			Environments(ctx)
}

@function
async def example(path: str) -> List[str]:
	return await (
		dag.pixi()
		.workspace(path)
		.environments()
	)

@func()
async example(path: string): Promise<string[]> {
	return dag
		.pixi()
		.workspace(path)
		.environments()
}

install() 🔗

Install a Pixi environment from the committed lock file.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
environment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
baseContainer	Container	null	Container to install into. Defaults to a Pixi image pinned to this workspace.
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected from the workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 install --environment string --dagger-codegen boolean

func (m *MyModule) Example(path string, environment string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			Workspace(path).
			Install(environment, daggerCodegen)
}

@function
def example(path: str, environment: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.workspace(path)
		.install(environment, dagger_codegen)
	)

@func()
example(path: string, environment: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.workspace(path)
		.install(environment, daggerCodegen)
}

installAllEnvironments() 🔗

Install every Pixi environment declared by the lock file into one container.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
baseContainer	Container	null	Container to install into. Defaults to a Pixi image pinned to this workspace.
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected from the workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 install-all-environments --dagger-codegen boolean

func (m *MyModule) Example(path string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			Workspace(path).
			InstallAllEnvironments(daggerCodegen)
}

@function
def example(path: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.workspace(path)
		.install_all_environments(dagger_codegen)
	)

@func()
example(path: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.workspace(path)
		.installAllEnvironments(daggerCodegen)
}

installEnvironments() 🔗

Install selected Pixi environments into one container.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
environments	[String ! ] !	-	Pixi environment names to install into the same container.
baseContainer	Container	null	Container to install into. Defaults to a Pixi image pinned to this workspace.
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected from the workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 install-environments --environments string1 --environments string2 --dagger-codegen boolean

func (m *MyModule) Example(path string, environments []string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			Workspace(path).
			InstallEnvironments(environments, daggerCodegen)
}

@function
def example(path: str, environments: List[str], dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.workspace(path)
		.install_environments(environments, dagger_codegen)
	)

@func()
example(path: string, environments: string[], daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.workspace(path)
		.installEnvironments(environments, daggerCodegen)
}

locked() 🔗

Verify this workspace’s lock file is up to date for all environments.

Return Type

Void !

Arguments

Name	Type	Default Value	Description
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected from the workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 locked

func (m *MyModule) Example(ctx context.Context, path string)   {
	return dag.
			Pixi().
			Workspace(path).
			Locked(ctx)
}

@function
async def example(path: str) -> None:
	return await (
		dag.pixi()
		.workspace(path)
		.locked()
	)

@func()
async example(path: string): Promise<void> {
	return dag
		.pixi()
		.workspace(path)
		.locked()
}

pixiVersion() 🔗

The Pixi version this workspace requires as a concrete image tag.

Return Type

String !

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 pixi-version

func (m *MyModule) Example(ctx context.Context, path string) string  {
	return dag.
			Pixi().
			Workspace(path).
			PixiVersion(ctx)
}

@function
async def example(path: str) -> str:
	return await (
		dag.pixi()
		.workspace(path)
		.pixi_version()
	)

@func()
async example(path: string): Promise<string> {
	return dag
		.pixi()
		.workspace(path)
		.pixiVersion()
}

run() 🔗

Install the environment and run a command through pixi run.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
args	[String ! ] !	-	Command argv passed to `pixi run`.
environment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
baseContainer	Container	null	Container to run in. Defaults to a Pixi image pinned to this workspace.
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected from the workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 run --args string1 --args string2 --environment string --dagger-codegen boolean

func (m *MyModule) Example(path string, args []string, environment string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			Workspace(path).
			Run(args, environment, daggerCodegen)
}

@function
def example(path: str, args: List[str], environment: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.workspace(path)
		.run(args, environment, dagger_codegen)
	)

@func()
example(path: string, args: string[], environment: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.workspace(path)
		.run(args, environment, daggerCodegen)
}

runtime() 🔗

Build a runtime container with one Pixi environment and no Pixi binary.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
environment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
runtimeBaseContainer	Container	null	Runtime base container. Defaults to `ubuntu:noble`.
runtimeImage	String !	"ubuntu:noble"	Runtime image used when `runtime_base_container` is not set.
baseContainer	Container	null	Builder container to install with Pixi. Defaults to a Pixi image pinned to this workspace.
pixiVersion	String	null	Pixi version image tag for the builder. Defaults to the version detected from the workspace.
image	String	null	Full Pixi builder image reference. Overrides `pixi_version`.
runtimeSourcePaths	[String ! ]	null	Relative source paths or glob patterns to copy into the runtime image. Defaults to the full source.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 runtime --environment string --runtime-image string --dagger-codegen boolean

func (m *MyModule) Example(path string, environment string, runtimeImage string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			Workspace(path).
			Runtime(environment, runtimeImage, daggerCodegen)
}

@function
def example(path: str, environment: str, runtime_image: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.workspace(path)
		.runtime(environment, runtime_image, dagger_codegen)
	)

@func()
example(path: string, environment: string, runtimeImage: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.workspace(path)
		.runtime(environment, runtimeImage, daggerCodegen)
}

runtimeAllEnvironments() 🔗

Build a runtime container with every Pixi environment and no Pixi binary.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
entrypointEnvironment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
runtimeBaseContainer	Container	null	Runtime base container. Defaults to `ubuntu:noble`.
runtimeImage	String !	"ubuntu:noble"	Runtime image used when `runtime_base_container` is not set.
baseContainer	Container	null	Builder container to install with Pixi. Defaults to a Pixi image pinned to this workspace.
pixiVersion	String	null	Pixi version image tag for the builder. Defaults to the version detected from the workspace.
image	String	null	Full Pixi builder image reference. Overrides `pixi_version`.
runtimeSourcePaths	[String ! ]	null	Relative source paths or glob patterns to copy into the runtime image. Defaults to the full source.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 runtime-all-environments --entrypoint-environment string --runtime-image string --dagger-codegen boolean

func (m *MyModule) Example(path string, entrypointEnvironment string, runtimeImage string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			Workspace(path).
			RuntimeAllEnvironments(entrypointEnvironment, runtimeImage, daggerCodegen)
}

@function
def example(path: str, entrypoint_environment: str, runtime_image: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.workspace(path)
		.runtime_all_environments(entrypoint_environment, runtime_image, dagger_codegen)
	)

@func()
example(path: string, entrypointEnvironment: string, runtimeImage: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.workspace(path)
		.runtimeAllEnvironments(entrypointEnvironment, runtimeImage, daggerCodegen)
}

runtimeEnvironments() 🔗

Build a runtime container with selected Pixi environments and no Pixi binary.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
environments	[String ! ] !	-	Pixi environment names to install into the same container.
entrypointEnvironment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
runtimeBaseContainer	Container	null	Runtime base container. Defaults to `ubuntu:noble`.
runtimeImage	String !	"ubuntu:noble"	Runtime image used when `runtime_base_container` is not set.
baseContainer	Container	null	Builder container to install with Pixi. Defaults to a Pixi image pinned to this workspace.
pixiVersion	String	null	Pixi version image tag for the builder. Defaults to the version detected from the workspace.
image	String	null	Full Pixi builder image reference. Overrides `pixi_version`.
runtimeSourcePaths	[String ! ]	null	Relative source paths or glob patterns to copy into the runtime image. Defaults to the full source.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 runtime-environments --environments string1 --environments string2 --entrypoint-environment string --runtime-image string --dagger-codegen boolean

func (m *MyModule) Example(path string, environments []string, entrypointEnvironment string, runtimeImage string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			Workspace(path).
			RuntimeEnvironments(environments, entrypointEnvironment, runtimeImage, daggerCodegen)
}

@function
def example(path: str, environments: List[str], entrypoint_environment: str, runtime_image: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.workspace(path)
		.runtime_environments(environments, entrypoint_environment, runtime_image, dagger_codegen)
	)

@func()
example(path: string, environments: string[], entrypointEnvironment: string, runtimeImage: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.workspace(path)
		.runtimeEnvironments(environments, entrypointEnvironment, runtimeImage, daggerCodegen)
}

shellHook() 🔗

Return Pixi’s activation shell hook for a named environment.

Return Type

String !

Arguments

Name	Type	Default Value	Description
environment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
json	Boolean !	true	Emit shell hook environment as JSON.
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected from the workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string \
 shell-hook --environment string --json boolean

func (m *MyModule) Example(ctx context.Context, path string, environment string, json bool) string  {
	return dag.
			Pixi().
			Workspace(path).
			ShellHook(ctx, environment, json)
}

@function
async def example(path: str, environment: str, json: bool) -> str:
	return await (
		dag.pixi()
		.workspace(path)
		.shell_hook(environment, json)
	)

@func()
async example(path: string, environment: string, json: boolean): Promise<string> {
	return dag
		.pixi()
		.workspace(path)
		.shellHook(environment, json)
}

Pixi 🔗

Entrypoint for the pixi module.

Root functions operate on the workspace at . by default and accept path for nested Pixi workspaces. Use workspace when you want to keep a PixiWorkspaceSource object around explicitly.

Learn more in the module docs and generated SDK reference.

source() 🔗

Source directory.

Return Type

Directory !

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 source

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			Pixi().
			Source()
}

@function
def example() -> dagger.Directory:
	return (
		dag.pixi()
		.source()
	)

@func()
example(): Directory {
	return dag
		.pixi()
		.source()
}

environments() 🔗

Pixi environments declared by the workspace manifest.

Return Type

[String ! ] !

Arguments

Name	Type	Default Value	Description
path	String !	"."	Path to the workspace root holding pixi.lock within the source directory.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 environments --path string

func (m *MyModule) Example(ctx context.Context, path string) []string  {
	return dag.
			Pixi().
			Environments(ctx, path)
}

@function
async def example(path: str) -> List[str]:
	return await (
		dag.pixi()
		.environments(path)
	)

@func()
async example(path: string): Promise<string[]> {
	return dag
		.pixi()
		.environments(path)
}

getWorkspaces() 🔗

Every Pixi workspace in the source tree, one per pixi.lock.

Return Type

[WorkspaceSource ! ] !

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 get-workspaces

func (m *MyModule) Example() []*dagger.PixiWorkspaceSource  {
	return dag.
			Pixi().
			GetWorkspaces()
}

@function
def example() -> List[dagger.PixiWorkspaceSource]:
	return (
		dag.pixi()
		.get_workspaces()
	)

@func()
example(): PixiWorkspaceSource[] {
	return dag
		.pixi()
		.getWorkspaces()
}

install() 🔗

Install one Pixi environment into a builder container.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
environment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
path	String !	"."	Path to the workspace root holding pixi.lock within the source directory.
baseContainer	Container	null	Container to install into. Defaults to a Pixi image pinned to the workspace.
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected from the workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 install --environment string --path string --dagger-codegen boolean

func (m *MyModule) Example(environment string, path string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			Install(environment, path, daggerCodegen)
}

@function
def example(environment: str, path: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.install(environment, path, dagger_codegen)
	)

@func()
example(environment: string, path: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.install(environment, path, daggerCodegen)
}

installAllEnvironments() 🔗

Install every Pixi environment into the same builder container.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
path	String !	"."	Path to the workspace root holding pixi.lock within the source directory.
baseContainer	Container	null	Container to install into. Defaults to a Pixi image pinned to the workspace.
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected from the workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 install-all-environments --path string --dagger-codegen boolean

func (m *MyModule) Example(path string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			InstallAllEnvironments(path, daggerCodegen)
}

@function
def example(path: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.install_all_environments(path, dagger_codegen)
	)

@func()
example(path: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.installAllEnvironments(path, daggerCodegen)
}

installEnvironments() 🔗

Install selected Pixi environments into the same builder container.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
environments	[String ! ] !	-	Pixi environment names to install into the same container.
path	String !	"."	Path to the workspace root holding pixi.lock within the source directory.
baseContainer	Container	null	Container to install into. Defaults to a Pixi image pinned to the workspace.
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected from the workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 install-environments --environments string1 --environments string2 --path string --dagger-codegen boolean

func (m *MyModule) Example(environments []string, path string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			InstallEnvironments(environments, path, daggerCodegen)
}

@function
def example(environments: List[str], path: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.install_environments(environments, path, dagger_codegen)
	)

@func()
example(environments: string[], path: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.installEnvironments(environments, path, daggerCodegen)
}

locked() 🔗

Verify every Pixi workspace lock file is up to date.

Return Type

Void !

Arguments

Name	Type	Default Value	Description
exclude	[String ! ]	null	Glob patterns of workspace paths to skip, e.g. `/tests/_packages/`.
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected per workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 locked

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			Pixi().
			Locked(ctx)
}

@function
async def example() -> None:
	return await (
		dag.pixi()
		.locked()
	)

@func()
async example(): Promise<void> {
	return dag
		.pixi()
		.locked()
}

run() 🔗

Install one environment and run a command through Pixi.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
args	[String ! ] !	-	Command argv passed to `pixi run`.
environment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
path	String !	"."	Path to the workspace root holding pixi.lock within the source directory.
baseContainer	Container	null	Container to run in. Defaults to a Pixi image pinned to the workspace.
pixiVersion	String	null	Pixi version image tag. Defaults to the version detected from the workspace.
image	String	null	Full Pixi image reference. Overrides `pixi_version`.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 run --args string1 --args string2 --environment string --path string --dagger-codegen boolean

func (m *MyModule) Example(args []string, environment string, path string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			Run(args, environment, path, daggerCodegen)
}

@function
def example(args: List[str], environment: str, path: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.run(args, environment, path, dagger_codegen)
	)

@func()
example(args: string[], environment: string, path: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.run(args, environment, path, daggerCodegen)
}

runtime() 🔗

Build a runtime container with one Pixi environment and no Pixi binary.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
environment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
path	String !	"."	Path to the workspace root holding pixi.lock within the source directory.
runtimeBaseContainer	Container	null	Runtime base container. Defaults to `ubuntu:noble`.
runtimeImage	String !	"ubuntu:noble"	Runtime image used when `runtime_base_container` is not set.
baseContainer	Container	null	Builder container to install with Pixi. Defaults to a Pixi image pinned to the workspace.
pixiVersion	String	null	Pixi version image tag for the builder. Defaults to the version detected from the workspace.
image	String	null	Full Pixi builder image reference. Overrides `pixi_version`.
runtimeSourcePaths	[String ! ]	null	Relative source paths or glob patterns to copy into the runtime image. Defaults to the full source.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 runtime --environment string --path string --runtime-image string --dagger-codegen boolean

func (m *MyModule) Example(environment string, path string, runtimeImage string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			Runtime(environment, path, runtimeImage, daggerCodegen)
}

@function
def example(environment: str, path: str, runtime_image: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.runtime(environment, path, runtime_image, dagger_codegen)
	)

@func()
example(environment: string, path: string, runtimeImage: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.runtime(environment, path, runtimeImage, daggerCodegen)
}

runtimeAllEnvironments() 🔗

Build a runtime container with every Pixi environment and no Pixi binary.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
entrypointEnvironment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
path	String !	"."	Path to the workspace root holding pixi.lock within the source directory.
runtimeBaseContainer	Container	null	Runtime base container. Defaults to `ubuntu:noble`.
runtimeImage	String !	"ubuntu:noble"	Runtime image used when `runtime_base_container` is not set.
baseContainer	Container	null	Builder container to install with Pixi. Defaults to a Pixi image pinned to the workspace.
pixiVersion	String	null	Pixi version image tag for the builder. Defaults to the version detected from the workspace.
image	String	null	Full Pixi builder image reference. Overrides `pixi_version`.
runtimeSourcePaths	[String ! ]	null	Relative source paths or glob patterns to copy into the runtime image. Defaults to the full source.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 runtime-all-environments --entrypoint-environment string --path string --runtime-image string --dagger-codegen boolean

func (m *MyModule) Example(entrypointEnvironment string, path string, runtimeImage string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			RuntimeAllEnvironments(entrypointEnvironment, path, runtimeImage, daggerCodegen)
}

@function
def example(entrypoint_environment: str, path: str, runtime_image: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.runtime_all_environments(entrypoint_environment, path, runtime_image, dagger_codegen)
	)

@func()
example(entrypointEnvironment: string, path: string, runtimeImage: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.runtimeAllEnvironments(entrypointEnvironment, path, runtimeImage, daggerCodegen)
}

runtimeEnvironments() 🔗

Build a runtime container with selected Pixi environments and no Pixi binary.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
environments	[String ! ] !	-	Pixi environment names to install into the same container.
entrypointEnvironment	String !	"default"	Pixi environment name. Defaults to the implicit `default` environment.
path	String !	"."	Path to the workspace root holding pixi.lock within the source directory.
runtimeBaseContainer	Container	null	Runtime base container. Defaults to `ubuntu:noble`.
runtimeImage	String !	"ubuntu:noble"	Runtime image used when `runtime_base_container` is not set.
baseContainer	Container	null	Builder container to install with Pixi. Defaults to a Pixi image pinned to the workspace.
pixiVersion	String	null	Pixi version image tag for the builder. Defaults to the version detected from the workspace.
image	String	null	Full Pixi builder image reference. Overrides `pixi_version`.
runtimeSourcePaths	[String ! ]	null	Relative source paths or glob patterns to copy into the runtime image. Defaults to the full source.
daggerCodegen	Boolean !	true	Run Dagger codegen and overlay sdk/ when the workspace is a Dagger module.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 runtime-environments --environments string1 --environments string2 --entrypoint-environment string --path string --runtime-image string --dagger-codegen boolean

func (m *MyModule) Example(environments []string, entrypointEnvironment string, path string, runtimeImage string, daggerCodegen bool) *dagger.Container  {
	return dag.
			Pixi().
			RuntimeEnvironments(environments, entrypointEnvironment, path, runtimeImage, daggerCodegen)
}

@function
def example(environments: List[str], entrypoint_environment: str, path: str, runtime_image: str, dagger_codegen: bool) -> dagger.Container:
	return (
		dag.pixi()
		.runtime_environments(environments, entrypoint_environment, path, runtime_image, dagger_codegen)
	)

@func()
example(environments: string[], entrypointEnvironment: string, path: string, runtimeImage: string, daggerCodegen: boolean): Container {
	return dag
		.pixi()
		.runtimeEnvironments(environments, entrypointEnvironment, path, runtimeImage, daggerCodegen)
}

workspace() 🔗

A single Pixi workspace at path within the source tree.

The returned workspace can install environments, run commands, and build runtime images without the Pixi binary.

Return Type

WorkspaceSource !

Arguments

Name	Type	Default Value	Description
path	String !	"."	Path to the workspace root holding pixi.lock within the source directory.

Example

dagger -m github.com/ascii-supply-networks/daggerverse/pixi@d484479660eeaa9bb8b5532cd2aff45a5a6a3b84 call \
 workspace --path string

func (m *MyModule) Example(path string) *dagger.PixiWorkspaceSource  {
	return dag.
			Pixi().
			Workspace(path)
}

@function
def example(path: str) -> dagger.PixiWorkspaceSource:
	return (
		dag.pixi()
		.workspace(path)
	)

@func()
example(path: string): PixiWorkspaceSource {
	return dag
		.pixi()
		.workspace(path)
}