Dagger Python SDK
A client package for running Dagger pipelines.
Tip
New to Dagger? Learn how it works and start using it.
Reference
- Connection
- Client
AddressAddressIDBindingBinding.as_address()Binding.as_cache_volume()Binding.as_changeset()Binding.as_check()Binding.as_check_group()Binding.as_cloud()Binding.as_container()Binding.as_directory()Binding.as_env()Binding.as_env_file()Binding.as_file()Binding.as_generator()Binding.as_generator_group()Binding.as_git_ref()Binding.as_git_repository()Binding.as_json_value()Binding.as_module()Binding.as_module_config_client()Binding.as_module_source()Binding.as_search_result()Binding.as_search_submatch()Binding.as_secret()Binding.as_service()Binding.as_socket()Binding.as_stat()Binding.as_string()Binding.as_workspace()Binding.digest()Binding.id()Binding.is_null()Binding.name()Binding.type_name()
BindingIDBuildArgCacheSharingModeCacheVolumeCacheVolumeIDChangesetChangesetIDChangesetMergeConflictChangesetsMergeConflictCheckCheckGroupCheckGroupIDCheckIDClientClient.address()Client.cache_volume()Client.cloud()Client.container()Client.current_env()Client.current_function_call()Client.current_module()Client.current_type_defs()Client.current_workspace()Client.default_platform()Client.directory()Client.engine()Client.env()Client.env_file()Client.error()Client.file()Client.function()Client.generated_code()Client.git()Client.host()Client.http()Client.json()Client.llm()Client.load_address_from_id()Client.load_binding_from_id()Client.load_cache_volume_from_id()Client.load_changeset_from_id()Client.load_check_from_id()Client.load_check_group_from_id()Client.load_cloud_from_id()Client.load_container_from_id()Client.load_current_module_from_id()Client.load_directory_from_id()Client.load_engine_cache_entry_from_id()Client.load_engine_cache_entry_set_from_id()Client.load_engine_cache_from_id()Client.load_engine_from_id()Client.load_enum_type_def_from_id()Client.load_enum_value_type_def_from_id()Client.load_env_file_from_id()Client.load_env_from_id()Client.load_env_variable_from_id()Client.load_error_from_id()Client.load_error_value_from_id()Client.load_field_type_def_from_id()Client.load_file_from_id()Client.load_function_arg_from_id()Client.load_function_call_arg_value_from_id()Client.load_function_call_from_id()Client.load_function_from_id()Client.load_generated_code_from_id()Client.load_generator_from_id()Client.load_generator_group_from_id()Client.load_git_ref_from_id()Client.load_git_repository_from_id()Client.load_host_from_id()Client.load_input_type_def_from_id()Client.load_interface_type_def_from_id()Client.load_json_value_from_id()Client.load_label_from_id()Client.load_list_type_def_from_id()Client.load_llm_from_id()Client.load_llm_token_usage_from_id()Client.load_module_config_client_from_id()Client.load_module_from_id()Client.load_module_source_from_id()Client.load_object_type_def_from_id()Client.load_port_from_id()Client.load_scalar_type_def_from_id()Client.load_sdk_config_from_id()Client.load_search_result_from_id()Client.load_search_submatch_from_id()Client.load_secret_from_id()Client.load_service_from_id()Client.load_socket_from_id()Client.load_source_map_from_id()Client.load_stat_from_id()Client.load_terminal_from_id()Client.load_type_def_from_id()Client.load_workspace_from_id()Client.module()Client.module_source()Client.secret()Client.set_secret()Client.source_map()Client.type_def()Client.version()
CloudCloudIDContainerContainer.as_service()Container.as_tarball()Container.combined_output()Container.default_args()Container.directory()Container.entrypoint()Container.env_variable()Container.env_variables()Container.exists()Container.exit_code()Container.experimental_with_all_gp_us()Container.experimental_with_gpu()Container.export()Container.export_image()Container.exposed_ports()Container.file()Container.from_()Container.id()Container.image_ref()Container.import_()Container.label()Container.labels()Container.mounts()Container.platform()Container.publish()Container.rootfs()Container.stat()Container.stderr()Container.stdout()Container.sync()Container.terminal()Container.up()Container.user()Container.with_()Container.with_annotation()Container.with_default_args()Container.with_default_terminal_cmd()Container.with_directory()Container.with_entrypoint()Container.with_env_file_variables()Container.with_env_variable()Container.with_error()Container.with_exec()Container.with_exposed_port()Container.with_file()Container.with_files()Container.with_label()Container.with_mounted_cache()Container.with_mounted_directory()Container.with_mounted_file()Container.with_mounted_secret()Container.with_mounted_temp()Container.with_new_file()Container.with_registry_auth()Container.with_rootfs()Container.with_secret_variable()Container.with_service_binding()Container.with_symlink()Container.with_unix_socket()Container.with_user()Container.with_workdir()Container.without_annotation()Container.without_default_args()Container.without_directory()Container.without_entrypoint()Container.without_env_variable()Container.without_exposed_port()Container.without_file()Container.without_files()Container.without_label()Container.without_mount()Container.without_registry_auth()Container.without_secret_variable()Container.without_unix_socket()Container.without_user()Container.without_workdir()Container.workdir()
ContainerIDCurrentModuleCurrentModuleIDDirectoryDirectory.as_git()Directory.as_module()Directory.as_module_source()Directory.changes()Directory.chown()Directory.diff()Directory.digest()Directory.directory()Directory.docker_build()Directory.entries()Directory.exists()Directory.export()Directory.file()Directory.filter()Directory.find_up()Directory.glob()Directory.id()Directory.name()Directory.search()Directory.stat()Directory.sync()Directory.terminal()Directory.with_()Directory.with_changes()Directory.with_directory()Directory.with_error()Directory.with_file()Directory.with_files()Directory.with_new_directory()Directory.with_new_file()Directory.with_patch()Directory.with_patch_file()Directory.with_symlink()Directory.with_timestamps()Directory.without_directory()Directory.without_file()Directory.without_files()
DirectoryIDEngineEngineCacheEngineCacheEntryEngineCacheEntryIDEngineCacheEntrySetEngineCacheEntrySetIDEngineCacheIDEngineIDEnumTypeDefEnumTypeDefIDEnumValueTypeDefEnumValueTypeDefIDEnvEnv.check()Env.checks()Env.id()Env.input()Env.inputs()Env.output()Env.outputs()Env.with_()Env.with_address_input()Env.with_address_output()Env.with_cache_volume_input()Env.with_cache_volume_output()Env.with_changeset_input()Env.with_changeset_output()Env.with_check_group_input()Env.with_check_group_output()Env.with_check_input()Env.with_check_output()Env.with_cloud_input()Env.with_cloud_output()Env.with_container_input()Env.with_container_output()Env.with_current_module()Env.with_directory_input()Env.with_directory_output()Env.with_env_file_input()Env.with_env_file_output()Env.with_env_input()Env.with_env_output()Env.with_file_input()Env.with_file_output()Env.with_generator_group_input()Env.with_generator_group_output()Env.with_generator_input()Env.with_generator_output()Env.with_git_ref_input()Env.with_git_ref_output()Env.with_git_repository_input()Env.with_git_repository_output()Env.with_json_value_input()Env.with_json_value_output()Env.with_main_module()Env.with_module()Env.with_module_config_client_input()Env.with_module_config_client_output()Env.with_module_input()Env.with_module_output()Env.with_module_source_input()Env.with_module_source_output()Env.with_search_result_input()Env.with_search_result_output()Env.with_search_submatch_input()Env.with_search_submatch_output()Env.with_secret_input()Env.with_secret_output()Env.with_service_input()Env.with_service_output()Env.with_socket_input()Env.with_socket_output()Env.with_stat_input()Env.with_stat_output()Env.with_string_input()Env.with_string_output()Env.with_workspace()Env.with_workspace_input()Env.with_workspace_output()Env.without_outputs()Env.workspace()
EnvFileEnvFileIDEnvIDEnvVariableEnvVariableIDErrorErrorIDErrorValueErrorValueIDExistsTypeFieldTypeDefFieldTypeDefIDFileFileIDFileTypeFunctionFunction.args()Function.deprecated()Function.description()Function.id()Function.name()Function.return_type()Function.source_map()Function.with_()Function.with_arg()Function.with_cache_policy()Function.with_check()Function.with_deprecated()Function.with_description()Function.with_generator()Function.with_source_map()
FunctionArgFunctionArgIDFunctionCachePolicyFunctionCallFunctionCallArgValueFunctionCallArgValueIDFunctionCallIDFunctionIDGeneratedCodeGeneratedCodeIDGeneratorGeneratorGroupGeneratorGroupIDGeneratorIDGitRefGitRefIDGitRepositoryGitRepositoryIDHostHostIDImageLayerCompressionImageMediaTypesInputTypeDefInputTypeDefIDInterfaceTypeDefInterfaceTypeDefIDJSONJSONValueJSONValueIDLLMLLM.attempt()LLM.bind_result()LLM.env()LLM.has_prompt()LLM.history()LLM.history_json()LLM.id()LLM.last_reply()LLM.loop()LLM.model()LLM.provider()LLM.step()LLM.sync()LLM.token_usage()LLM.tools()LLM.with_()LLM.with_blocked_function()LLM.with_env()LLM.with_mcp_server()LLM.with_model()LLM.with_prompt()LLM.with_prompt_file()LLM.with_static_tools()LLM.with_system_prompt()LLM.without_default_system_prompt()LLM.without_message_history()LLM.without_system_prompts()
LLMIDLLMTokenUsageLLMTokenUsageIDLabelLabelIDListTypeDefListTypeDefIDModuleModule.check()Module.checks()Module.dependencies()Module.description()Module.enums()Module.generated_context_directory()Module.generator()Module.generators()Module.id()Module.interfaces()Module.introspection_schema_json()Module.name()Module.objects()Module.runtime()Module.sdk()Module.serve()Module.source()Module.sync()Module.user_defaults()Module.with_()Module.with_description()Module.with_enum()Module.with_interface()Module.with_object()
ModuleConfigClientModuleConfigClientIDModuleIDModuleSourceModuleSource.as_module()ModuleSource.as_string()ModuleSource.blueprint()ModuleSource.clone_ref()ModuleSource.commit()ModuleSource.config_clients()ModuleSource.config_exists()ModuleSource.context_directory()ModuleSource.dependencies()ModuleSource.digest()ModuleSource.directory()ModuleSource.engine_version()ModuleSource.generated_context_directory()ModuleSource.html_repo_url()ModuleSource.html_url()ModuleSource.id()ModuleSource.introspection_schema_json()ModuleSource.kind()ModuleSource.local_context_directory_path()ModuleSource.module_name()ModuleSource.module_original_name()ModuleSource.original_subpath()ModuleSource.pin()ModuleSource.repo_root_path()ModuleSource.sdk()ModuleSource.source_root_subpath()ModuleSource.source_subpath()ModuleSource.sync()ModuleSource.toolchains()ModuleSource.user_defaults()ModuleSource.version()ModuleSource.with_()ModuleSource.with_blueprint()ModuleSource.with_client()ModuleSource.with_dependencies()ModuleSource.with_engine_version()ModuleSource.with_experimental_features()ModuleSource.with_includes()ModuleSource.with_name()ModuleSource.with_sdk()ModuleSource.with_source_subpath()ModuleSource.with_toolchains()ModuleSource.with_update_blueprint()ModuleSource.with_update_dependencies()ModuleSource.with_update_toolchains()ModuleSource.with_updated_clients()ModuleSource.without_blueprint()ModuleSource.without_client()ModuleSource.without_dependencies()ModuleSource.without_experimental_features()ModuleSource.without_toolchains()
ModuleSourceExperimentalFeatureModuleSourceIDModuleSourceKindNetworkProtocolObjectTypeDefObjectTypeDefIDPipelineLabelPlatformPortPortForwardPortIDReturnTypeSDKConfigSDKConfigIDScalarTypeDefScalarTypeDefIDSearchResultSearchResultIDSearchSubmatchSearchSubmatchIDSecretSecretIDServiceServiceIDSocketSocketIDSourceMapSourceMapIDStatStatIDTerminalTerminalIDTypeDefTypeDef.as_enum()TypeDef.as_input()TypeDef.as_interface()TypeDef.as_list()TypeDef.as_object()TypeDef.as_scalar()TypeDef.id()TypeDef.kind()TypeDef.optional()TypeDef.with_()TypeDef.with_constructor()TypeDef.with_enum()TypeDef.with_enum_member()TypeDef.with_enum_value()TypeDef.with_field()TypeDef.with_function()TypeDef.with_interface()TypeDef.with_kind()TypeDef.with_list_of()TypeDef.with_object()TypeDef.with_optional()TypeDef.with_scalar()
TypeDefIDTypeDefKindTypeDefKind.BOOLEANTypeDefKind.BOOLEAN_KINDTypeDefKind.ENUMTypeDefKind.ENUM_KINDTypeDefKind.FLOATTypeDefKind.FLOAT_KINDTypeDefKind.INPUTTypeDefKind.INPUT_KINDTypeDefKind.INTEGERTypeDefKind.INTEGER_KINDTypeDefKind.INTERFACETypeDefKind.INTERFACE_KINDTypeDefKind.LISTTypeDefKind.LIST_KINDTypeDefKind.OBJECTTypeDefKind.OBJECT_KINDTypeDefKind.SCALARTypeDefKind.SCALAR_KINDTypeDefKind.STRINGTypeDefKind.STRING_KINDTypeDefKind.VOIDTypeDefKind.VOID_KIND
VoidWorkspaceWorkspaceID
- Exceptions
- Modules