Dagger Go SDK

https://pkg.go.dev/dagger.io/dagger
Admin
The Dagger Go SDK contains everything you need to develop CI/CD pipelines in Go, and run them with...
Tokens:256,698
Snippets:2,918
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Directory Listing Example

Source: https://pkg.go.dev/dagger.io/dagger

Example output showing files within a directory.

```text
[goodbye.txt hello.txt]
```

--------------------------------

### Start Service

Source: https://pkg.go.dev/dagger.io/dagger

Starts the service and waits for its health checks to succeed. Services bound to a Container do not need to be manually started.

```go
func (r *Service) Start(ctx context.Context) (*Service, error)
```

--------------------------------

### Retrieve all services defined by installed modules

Source: https://pkg.go.dev/dagger.io/dagger

Use the Services function to get all services defined by the installed modules. Note that the Services API is experimental and may change.

```go
func (r *Env) Services(opts ...EnvServicesOpts) *UpGroup
```

--------------------------------

### Get SearchSubmatch Start Offset

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the start offset of a match within its line. Requires a context.

```go
func (r *SearchSubmatch) Start(ctx context.Context) (int, error)
```

--------------------------------

### Install Module into Environment (Deprecated)

Source: https://pkg.go.dev/dagger.io/dagger

Installs a module into the environment, exposing its functions to the model. Contextual path arguments will be populated using the environment's workspace. Use withMainModule instead.

```go
func (r *Env) WithModule(module *Module) *Env
```

--------------------------------

### Get Entrypoint

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the container's OCI entrypoint.

```go
func (r *Container) Entrypoint(ctx context.Context) ([]string, error)

```

--------------------------------

### Install the current module into the environment

Source: https://pkg.go.dev/dagger.io/dagger

The WithCurrentModule function installs the current module into the environment, making its functions available. Contextual path arguments are populated using the environment's workspace.

```go
func (r *Env) WithCurrentModule() *Env
```

--------------------------------

### Service.Start

Source: https://pkg.go.dev/dagger.io/dagger

Starts the service and waits for its health checks to succeed. Services bound to a Container do not need to be manually started.

```APIDOC
## Service.Start

### Description
Start the service and wait for its health checks to succeed. Services bound to a Container do not need to be manually started.

### Method
* (r *Service) Start(ctx context.Context) (*Service, error)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- ***Service**: A pointer to the started Service object.
- **error**: An error if the service failed to start.

#### Response Example
None
```

--------------------------------

### Get Module Source

Source: https://pkg.go.dev/dagger.io/dagger

Retrieve the source code for the module.

```go
func (r *Module) Source() *ModuleSource
```

--------------------------------

### ContainerOpts for Container Initialization

Source: https://pkg.go.dev/dagger.io/dagger

Options for initializing a new container. Allows specifying the platform for the container.

```go
type ContainerOpts struct {
	// Platform to initialize the container with. Defaults to the native platform of the current engine
	Platform Platform
}
```

--------------------------------

### Get Current Environment

Source: https://pkg.go.dev/dagger.io/dagger

Returns the current environment. When called from an LLM tool, it reflects the LLM's environment. Otherwise, it returns an Env with the current module installed.

```go
func (r *Query) CurrentEnv() *Env
```

--------------------------------

### Query.EnvFile

Source: https://pkg.go.dev/dagger.io/dagger

Initializes an environment file.

```APIDOC
## Query.EnvFile

### Description
Initializes an environment file.

### Method
N/A (This is a Go function signature, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **opts** ([]EnvFileOpts) - Optional configuration options for the environment file.

### Request Example
N/A

### Response
#### Success Response
- **EnvFile** (*EnvFile) - The initialized environment file object.

#### Response Example
N/A
```

--------------------------------

### HealthcheckConfig StartPeriod Method

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the initial startup period during which failures do not count towards retries. Example: 0s.

```go
func (r *HealthcheckConfig) StartPeriod(ctx context.Context) (string, error)
```

--------------------------------

### Initialize New Environment

Source: https://pkg.go.dev/dagger.io/dagger/dag

Initializes a new environment. Note that environments are not yet stabilized and may change.

```go
func Env(opts ...dagger.EnvOpts) *dagger.Env
```

--------------------------------

### Get ModuleConfigClient ID

Source: https://pkg.go.dev/dagger.io/dagger

Get a unique identifier for this ModuleConfigClient. Requires a context.

```go
func (r *ModuleConfigClient) ID(ctx context.Context) (ID, error)
```

--------------------------------

### Query.Env

Source: https://pkg.go.dev/dagger.io/dagger

Initializes a new environment. This API is experimental.

```APIDOC
## Query.Env

### Description
Initializes a new environment. This API is experimental.

### Method
N/A (This is a Go function signature, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **opts** ([]EnvOpts) - Optional configuration options for the environment.

### Request Example
N/A

### Response
#### Success Response
- **Env** (*Env) - The initialized environment object.

#### Response Example
N/A
```

--------------------------------

### FromDownloadedCLI

Source: https://pkg.go.dev/dagger.io/dagger/engineconn

Establishes an EngineConn by downloading the Dagger CLI if it's not already present. It takes a context and a configuration object, returning the EngineConn and an error if any.

```APIDOC
## func FromDownloadedCLI

### Description
Establishes an EngineConn by downloading the Dagger CLI if it's not already present. It takes a context and a configuration object, returning the EngineConn and an error if any.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **ctx** (context.Context) - The context for the operation.
* **cfg** (*Config) - The configuration for the connection.

### Returns
* **EngineConn** - The established engine connection.
* **error** - An error if the connection fails.
```

--------------------------------

### Get ModuleConfigClient Generator

Source: https://pkg.go.dev/dagger.io/dagger

Get the generator to be used by the ModuleConfigClient. Requires a context.

```go
func (r *ModuleConfigClient) Generator(ctx context.Context) (string, error)
```

--------------------------------

### Env

Source: https://pkg.go.dev/dagger.io/dagger/dag

Initializes a new environment. This is an experimental feature.

```APIDOC
## Env

### Description
Initializes a new environment.

Experimental: Environments are not yet stabilized.

### Signature
```go
func Env(opts ...dagger.EnvOpts) *dagger.Env
```
```

--------------------------------

### Get ModuleConfigClient Directory

Source: https://pkg.go.dev/dagger.io/dagger

Get the directory where the ModuleConfigClient is generated. Requires a context.

```go
func (r *ModuleConfigClient) Directory(ctx context.Context) (string, error)
```

--------------------------------

### ContainerUpOpts Configuration

Source: https://pkg.go.dev/dagger.io/dagger

Options for the Container.Up function. Use Random for random host port binding, Ports for explicit port forwarding, Args to override the default command, UseEntrypoint to include the container's entrypoint, ExperimentalPrivilegedNesting for Dagger access, InsecureRootCapabilities for root privileges (use with caution), Expand for environment variable substitution in args, and NoInit to skip the default init process.

```go
type ContainerUpOpts struct {
	// Bind each tunnel port to a random port on the host.
	Random bool
	// List of frontend/backend port mappings to forward.
	//
	// Frontend is the port accepting traffic on the host, backend is the service port.
	Ports []PortForward
	// Command to run instead of the container's default command (e.g., ["go", "run", "main.go"])
	//
	// If empty, the container's default command is used.
	Args []string
	// If the container has an entrypoint, prepend it to the args.
	UseEntrypoint bool
	// Provides Dagger access to the executed command.
	ExperimentalPrivilegedNesting bool
	// Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
	InsecureRootCapabilities bool
	// Replace "${VAR}" or "$VAR" in the args according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
	// If set, skip the automatic init process injected into containers by default.
	//
	// This should only be used if the user requires that their exec process be the pid 1 process in the container. Otherwise it may result in unexpected behavior.
	NoInit bool
}
```

--------------------------------

### Get File GraphQL Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name.

```go
func (r *File) XXX_GraphQLType() string
```

--------------------------------

### Env.Services

Source: https://pkg.go.dev/dagger.io/dagger

Returns all services defined by the installed modules. This API is experimental.

```APIDOC
## Env.Services

### Description
Returns all services defined by the installed modules. This API is experimental and may be removed or replaced.

### Method
*Env.Services*

### Parameters
#### Path Parameters
- **opts** (...EnvServicesOpts) - Optional - Options for retrieving services.
```

--------------------------------

### Initialize Environment File

Source: https://pkg.go.dev/dagger.io/dagger/dag

Initializes an environment file. This can be used to load environment variables from a file.

```go
func EnvFile(opts ...dagger.EnvFileOpts) *dagger.EnvFile
```

--------------------------------

### Get Directory Name

Source: https://pkg.go.dev/dagger.io/dagger

Returns the name of the directory.

```go
func (r *Directory) Name(ctx context.Context) (string, error)
```

--------------------------------

### EnvFile

Source: https://pkg.go.dev/dagger.io/dagger/dag

Initializes an environment file.

```APIDOC
## EnvFile

### Description
Initialize an environment file.

### Signature
```go
func EnvFile(opts ...dagger.EnvFileOpts) *dagger.EnvFile
```
```

--------------------------------

### Get SearchSubmatch Internal GraphQL Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for a SearchSubmatch.

```go
func (r *SearchSubmatch) XXX_GraphQLType() string
```

--------------------------------

### Get Internal ModuleConfigClient GraphQL Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for ModuleConfigClient.

```go
func (r *ModuleConfigClient) XXX_GraphQLType() string
```

--------------------------------

### Configure Client to Load Workspace Modules

Source: https://pkg.go.dev/dagger.io/dagger

Opts the client into loading workspace modules based on the working directory when the session is created via the CLI.

```go
func WithLoadWorkspaceModules() ClientOpt
```

--------------------------------

### Get SDK Configuration of Module

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the SDK configuration of the module. Added in v0.16.0.

```go
func (r *ModuleSource) SDK() *SDKConfig
```

--------------------------------

### File AsEnvFile Method

Source: https://pkg.go.dev/dagger.io/dagger

Parses the file contents as an environment file.

```go
func (r *File) AsEnvFile(opts ...FileAsEnvFileOpts) *EnvFile
```

--------------------------------

### Get HTTPState GraphQL ID

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the underlying GraphQL ID of the HTTPState. Requires a context.

```go
func (r *HTTPState) XXX_GraphQLID(ctx context.Context) (string, error)
```

--------------------------------

### Get GitRepository GraphQL Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the GitRepository object.

```go
func (r *GitRepository) XXX_GraphQLType() string
```

--------------------------------

### Container.Up

Source: https://pkg.go.dev/dagger.io/dagger

Starts the container and brings it to an 'up' state, optionally applying configuration options. This is often a prerequisite for other operations.

```APIDOC
## Container.Up

### Description
Starts the container and brings it to an 'up' state, optionally applying configuration options. This is often a prerequisite for other operations.

### Method
(Implicitly called via Container object)

### Endpoint
N/A (SDK method)

### Parameters
- `ctx` (context.Context) - The context for the operation.
- `opts` ([]ContainerUpOpts) - Optional configuration options for starting the container.

### Response
- `error` - An error if the container fails to start.
```

--------------------------------

### Module Description Method

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the documentation string for the module, if any.

```go
func (r *Module) Description(ctx context.Context) (string, error)
```

--------------------------------

### Get GitRepository GraphQL ID

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the underlying GraphQL ID of the GitRepository. Requires a context.

```go
func (r *GitRepository) XXX_GraphQLID(ctx context.Context) (string, error)
```

--------------------------------

### Get Available Tools Documentation

Source: https://pkg.go.dev/dagger.io/dagger

Prints documentation for the tools that are available to the LLM. This helps in understanding what functionalities can be invoked.

```go
func (r *LLM) Tools(ctx context.Context) (string, error)
```

--------------------------------

### Get File GraphQL ID

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the underlying type ID for GraphQL. Requires a context.

```go
func (r *File) XXX_GraphQLID(ctx context.Context) (string, error)
```

--------------------------------

### Get CheckGroup Internal GraphQL Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the CheckGroup.

```go
func (r *CheckGroup) XXX_GraphQLType() string
```

--------------------------------

### Container.Up Options

Source: https://pkg.go.dev/dagger.io/dagger

Options for configuring the Container.Up method, which starts a container and optionally forwards ports, sets commands, or manages environment variables.

```APIDOC
## Container.Up Options

### Description
Options for configuring the Container.Up method, which starts a container and optionally forwards ports, sets commands, or manages environment variables.

### Type Definition
```go
type ContainerUpOpts struct {
	// Bind each tunnel port to a random port on the host.
	Random bool
	// List of frontend/backend port mappings to forward.
	//
	// Frontend is the port accepting traffic on the host, backend is the service port.
	Ports []PortForward
	// Command to run instead of the container's default command (e.g., ["go", "run", "main.go"])
	//
	// If empty, the container's default command is used.
	Args []string
	// If the container has an entrypoint, prepend it to the args.
	UseEntrypoint bool
	// Provides Dagger access to the executed command.
	ExperimentalPrivilegedNesting bool
	// Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
	InsecureRootCapabilities bool
	// Replace "${VAR}" or "$VAR" in the args according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
	// If set, skip the automatic init process injected into containers by default.
	//
	// This should only be used if the user requires that their exec process be the pid 1 process in the container. Otherwise it may result in unexpected behavior.
	NoInit bool
}
```
```

--------------------------------

### Get Check Internal GraphQL Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the check.

```go
func (r *Check) XXX_GraphQLType() string
```

--------------------------------

### CurrentModule.WorkdirFile Method

Source: https://pkg.go.dev/dagger.io/dagger

Loads a file from the module's scratch working directory, including any changes made during execution.

```go
func (r *CurrentModule) WorkdirFile(path string) *File
```

--------------------------------

### Configure Client with Workdir

Source: https://pkg.go.dev/dagger.io/dagger

Sets the working directory for the Dagger engine.

```go
func WithWorkdir(path string) ClientOpt
```

--------------------------------

### Get SearchSubmatch Internal GraphQL ID

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the underlying type ID for a SearchSubmatch. Requires a context.

```go
func (r *SearchSubmatch) XXX_GraphQLID(ctx context.Context) (string, error)
```

--------------------------------

### FileOpts Struct

Source: https://pkg.go.dev/dagger.io/dagger

Options for Query.File, specifying permissions for a new file. Defaults to 420 if not provided.

```go
type FileOpts struct {
	// Permissions of the new file. Example: 0600
	//
	// Default: 420
	Permissions int
}
```

--------------------------------

### Get Internal ModuleConfigClient GraphQL ID

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the underlying type ID for ModuleConfigClient. Requires a context.

```go
func (r *ModuleConfigClient) XXX_GraphQLID(ctx context.Context) (string, error)
```

--------------------------------

### Env.WithCurrentModule

Source: https://pkg.go.dev/dagger.io/dagger

Installs the current module into the environment, exposing its functions to the model.

```APIDOC
## Env.WithCurrentModule

### Description
Installs the current module into the environment, exposing its functions to the model. Contextual path arguments will be populated using the environment's workspace.

### Method
*Env.WithCurrentModule*
```

--------------------------------

### DirectoryWithNewFileOpts Structure

Source: https://pkg.go.dev/dagger.io/dagger

Defines options for creating a new file, specifying permissions.

```go
type DirectoryWithNewFileOpts struct {
	// Permissions of the new file. Example: 0600
	//
	// Default: 420
	Permissions int
}
```

--------------------------------

### Get CheckGroup Internal GraphQL ID

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the underlying type ID of the CheckGroup. Requires a context.

```go
func (r *CheckGroup) XXX_GraphQLID(ctx context.Context) (string, error)
```

--------------------------------

### Get Check Internal GraphQL ID

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the underlying type ID of the check. Requires a context.

```go
func (r *Check) XXX_GraphQLID(ctx context.Context) (string, error)
```

--------------------------------

### Host FindUp Method

Source: https://pkg.go.dev/dagger.io/dagger

Searches for a file or directory by walking up the directory tree from the system workdir. Returns its relative path or null if no match.

```go
func (r *Host) FindUp(ctx context.Context, name string, opts ...HostFindUpOpts) (string, error)
```

--------------------------------

### Get Secret Internal GraphQL Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for a Secret. Added in v0.4.0.

```go
func (r *Secret) XXX_GraphQLType() string
```

--------------------------------

### Address File Method

Source: https://pkg.go.dev/dagger.io/dagger

Loads a file from the given address, with optional configuration options.

```go
func (r *Address) File(opts ...AddressFileOpts) *File
```

--------------------------------

### Get SearchSubmatch Internal GraphQL ID Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the ID of a SearchSubmatch.

```go
func (r *SearchSubmatch) XXX_GraphQLIDType() string
```

--------------------------------

### Query.Container Options

Source: https://pkg.go.dev/dagger.io/dagger

Options for initializing a new container, primarily for setting the platform.

```APIDOC
## Query.Container Options

### Description
Options for initializing a new container. The primary option is to specify the desired platform for the container.

### Type
`ContainerOpts`

### Fields
- **Platform** (`Platform`) - Platform to initialize the container with. Defaults to the native platform of the current engine.
```

--------------------------------

### ContainerWithFilesOpts

Source: https://pkg.go.dev/dagger.io/dagger

Options for Container.WithFiles. Similar to WithFile, but for copying multiple files, allowing specification of permissions, owner, and environment variable expansion.

```go
type ContainerWithFilesOpts struct {
	// Permission given to the copied files (e.g., 0600).
	Permissions int
	// A user:group to set for the files.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}
```

--------------------------------

### Get HTTPState GraphQL ID Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the ID of this HTTPState object.

```go
func (r *HTTPState) XXX_GraphQLIDType() string
```

--------------------------------

### Connect to Dagger Engine

Source: https://pkg.go.dev/dagger.io/dagger

Establishes a connection to a Dagger Engine. Accepts optional client options and requires a context.

```go
func Connect(ctx context.Context, opts ...ClientOpt) (*Client, error)
```

--------------------------------

### Get GitRepository GraphQL ID Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the ID of this GitRepository object.

```go
func (r *GitRepository) XXX_GraphQLIDType() string
```

--------------------------------

### ModuleSource.ContextDirectory Method

Source: https://pkg.go.dev/dagger.io/dagger

Returns the full directory loaded for the module source, including the source code as a subdirectory.

```go
func (r *ModuleSource) ContextDirectory() *Directory
```

--------------------------------

### Get File GraphQL ID Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the object's ID.

```go
func (r *File) XXX_GraphQLIDType() string
```

--------------------------------

### Get

Source: https://pkg.go.dev/dagger.io/dagger/engineconn

A general-purpose function to get an EngineConn, attempting to use the most appropriate method based on the configuration and environment. It returns the EngineConn and an error.

```APIDOC
## func Get

### Description
A general-purpose function to get an EngineConn, attempting to use the most appropriate method based on the configuration and environment. It returns the EngineConn and an error.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **ctx** (context.Context) - The context for the operation.
* **cfg** (*Config) - The configuration for the connection.

### Returns
* **EngineConn** - The established engine connection.
* **error** - An error if the connection fails.
```

--------------------------------

### ContainerWithDirectoryOpts Configuration

Source: https://pkg.go.dev/dagger.io/dagger

Options for Container.WithDirectory. Use Exclude and Include for file filtering, Gitignore to apply .gitignore rules, Owner to set user:group, Expand for environment variable substitution in path, and Permissions for file permissions.

```go
type ContainerWithDirectoryOpts struct {
	// Patterns to exclude in the written directory (e.g. ["node_modules/**", ".gitignore", ".git/"])
	Exclude []string
	// Patterns to include in the written directory (e.g. ["*.go", "go.mod", "go.sum"])
	Include []string
	// Apply .gitignore rules when writing the directory.
	Gitignore bool
	// A user:group to set for the directory and its contents.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool

	Permissions int
}
```

--------------------------------

### Get Secret Internal GraphQL ID

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the underlying type ID for a Secret. Requires a context. Added in v0.4.0.

```go
func (r *Secret) XXX_GraphQLID(ctx context.Context) (string, error)
```

--------------------------------

### Host File Method

Source: https://pkg.go.dev/dagger.io/dagger

Accesses a file on the host.

```go
func (r *Host) File(path string, opts ...HostFileOpts) *File
```

--------------------------------

### Get Internal ModuleConfigClient GraphQL ID Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the ID of this ModuleConfigClient object.

```go
func (r *ModuleConfigClient) XXX_GraphQLIDType() string
```

--------------------------------

### Up.Description Method

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the description of the service.

```go
func (r *Up) Description(ctx context.Context) (string, error)
```

--------------------------------

### Get CheckGroup Internal GraphQL ID Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the CheckGroup's ID.

```go
func (r *CheckGroup) XXX_GraphQLIDType() string
```

--------------------------------

### Get Check Internal GraphQL ID Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the check's ID.

```go
func (r *Check) XXX_GraphQLIDType() string
```

--------------------------------

### CurrentModule.Workdir Method

Source: https://pkg.go.dev/dagger.io/dagger

Loads a directory from the module's scratch working directory, including any changes made during execution.

```go
func (r *CurrentModule) Workdir(path string, opts ...CurrentModuleWorkdirOpts) *Directory
```

--------------------------------

### Get Secret Internal GraphQL ID Type

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name for the ID of a Secret. Added in v0.7.2.

```go
func (r *Secret) XXX_GraphQLIDType() string
```

--------------------------------

### HealthcheckConfig StartInterval Method

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the duration between checks during the startup phase. Example: 5s.

```go
func (r *HealthcheckConfig) StartInterval(ctx context.Context) (string, error)
```

--------------------------------

### Get Function Signature

Source: https://pkg.go.dev/dagger.io/dagger/engineconn

Generic function signature to get an EngineConn. It attempts to establish a connection based on the provided configuration, handling different connection strategies.

```go
func Get(ctx context.Context, cfg *Config) (EngineConn, error)
```

--------------------------------

### Declare a Directory output binding

Source: https://pkg.go.dev/dagger.io/dagger

Use WithDirectoryOutput to declare a desired Directory output binding for the environment. Specify the name and a description for the output.

```go
func (r *Env) WithDirectoryOutput(name string, description string) *Env
```

--------------------------------

### HealthcheckConfig Methods

Source: https://pkg.go.dev/dagger.io/dagger

Provides access to various configuration settings for health checks, including ID, interval, retries, shell, start interval, start period, and timeout.

```APIDOC
## HealthcheckConfig Methods

### Description
Provides access to various configuration settings for health checks, including ID, interval, retries, shell, start interval, start period, and timeout.

### Methods
- `ID(ctx context.Context) (ID, error)`: Retrieves the unique identifier for the healthcheck configuration.
- `Interval(ctx context.Context) (string, error)`: Gets the health check interval.
- `Retries(ctx context.Context) (int, error)`: Retrieves the number of retries for health checks.
- `Shell(ctx context.Context) (bool, error)`: Checks if a shell is used for health checks.
- `StartInterval(ctx context.Context) (string, error)`: Gets the interval for starting health checks.
- `StartPeriod(ctx context.Context) (string, error)`: Gets the period for starting health checks.
- `Timeout(ctx context.Context) (string, error)`: Gets the timeout for health checks.
- `WithGraphQLQuery(q *querybuilder.Selection) *HealthcheckConfig`: Configures the healthcheck with a GraphQL query selection.
- `XXX_GraphQLID(ctx context.Context) (string, error)`: Internal method for GraphQL ID retrieval.
- `XXX_GraphQLIDType() string`: Internal method for GraphQL ID type.
- `XXX_GraphQLType() string`: Internal method for GraphQL type.
```

--------------------------------

### Create File from Contents

Source: https://pkg.go.dev/dagger.io/dagger

Creates a file with the specified name and contents. Optional file options can be provided.

```go
func (r *Query) File(name string, contents string, opts ...FileOpts) *File
```

--------------------------------

### Configure Client with Log Output Writer

Source: https://pkg.go.dev/dagger.io/dagger

Sets the progress writer for client logs. Accepts an io.Writer.

```go
func WithLogOutput(writer io.Writer) ClientOpt
```

--------------------------------

### Load Directory as Module

Source: https://pkg.go.dev/dagger.io/dagger

Loads a directory as a Dagger module source. Use DirectoryAsModuleOpts for configuration.

```go
func (r *Directory) AsModule(opts ...DirectoryAsModuleOpts) *Module
```

--------------------------------

### DirectoryStatOpts

Source: https://pkg.go.dev/dagger.io/dagger

Options for getting file status. Control whether to follow symbolic links.

```go
type DirectoryStatOpts struct {
	// If specified, do not follow symlinks.
	DoNotFollowSymlinks bool
}
```

--------------------------------

### Container.Entrypoint

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the entrypoint of the container. The entrypoint defines the executable that runs when the container starts.

```APIDOC
## Container.Entrypoint

### Description
Retrieves the entrypoint of the container. The entrypoint defines the executable that runs when the container starts.

### Method
(Implicitly called via Container object)

### Endpoint
N/A (SDK method)

### Parameters
- `ctx` (context.Context) - The context for the operation.

### Response
- `[]string` - A slice of strings representing the entrypoint command and arguments.
- `error` - An error if the operation fails.
```

--------------------------------

### Start Service and Forward Traffic

Source: https://pkg.go.dev/dagger.io/dagger

Starts a service and creates a tunnel to forward traffic from the caller's network to that service. Ensure exposed ports are set before calling. Available since v0.13.2.

```go
func (r *Container) Up(ctx context.Context, opts ...ContainerUpOpts) error
```

--------------------------------

### Module SDK Method

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the SDK configuration used by this module.

```go
func (r *Module) SDK() *SDKConfig
```

--------------------------------

### Directory.Name

Source: https://pkg.go.dev/dagger.io/dagger

Gets the name of the directory.

```APIDOC
## Directory.Name

### Description
Gets the name of the directory.

### Method
N/A (This is a Go method, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.

### Response
#### Success Response
- Returns a string representing the directory's name.

### Request Example
N/A

### Response Example
N/A
```

--------------------------------

### Create File with Contents

Source: https://pkg.go.dev/dagger.io/dagger/dag

Creates a file with the specified name, contents, and optional options. Use this to define file content within Dagger.

```go
func File(name string, contents string, opts ...dagger.FileOpts) *dagger.File
```

--------------------------------

### RemoteGitMirror.ID

Source: https://pkg.go.dev/dagger.io/dagger

Get a unique identifier for this RemoteGitMirror.

```APIDOC
## ID

### Description
A unique identifier for this RemoteGitMirror.

### Method
(RemoteGitMirror).ID

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the request.

### Response
#### Success Response
- **ID** - The unique identifier for the RemoteGitMirror.
```

--------------------------------

### Up.Run Method

Source: https://pkg.go.dev/dagger.io/dagger

Executes the service function. Returns a new Up instance representing the executed service.

```go
func (r *Up) Run() *Up
```

--------------------------------

### DiffStat.Path

Source: https://pkg.go.dev/dagger.io/dagger

Gets the path of a diff stat.

```APIDOC
## DiffStat.Path

### Description
Gets the path of a diff stat.

### Method
N/A (This is a Go method, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.

### Response
#### Success Response
- Returns a string representing the path.

### Request Example
N/A

### Response Example
N/A
```

--------------------------------

### Module Runtime Method

Source: https://pkg.go.dev/dagger.io/dagger

Returns the container that runs the module's entrypoint. It will fail if the module doesn't compile.

```go
func (r *Module) Runtime() *Container
```

--------------------------------

### Get TypeDef ID

Source: https://pkg.go.dev/dagger.io/dagger

A unique identifier for this TypeDef.

```go
func (r *TypeDef) ID(ctx context.Context) (ID, error)
```

--------------------------------

### Create Module from Source Reference

Source: https://pkg.go.dev/dagger.io/dagger/dag

Instantiate a new module source from a given source reference string. Available since v0.9.8.

```go
func ModuleSource(refString string, opts ...dagger.ModuleSourceOpts) *dagger.ModuleSource
```

--------------------------------

### Get File Stat

Source: https://pkg.go.dev/dagger.io/dagger

Returns the status of the file.

```go
func (r *File) Stat() *Stat
```

--------------------------------

### ContainerWithNewFileOpts

Source: https://pkg.go.dev/dagger.io/dagger

Options for Container.WithNewFile. Allows setting permissions, owner, and environment variable expansion for a new file.

```go
type ContainerWithNewFileOpts struct {
	// Permissions of the new file. Example: 0600
	//
	// Default: 420
	Permissions int
	// A user:group to set for the file.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}
```

--------------------------------

### Provide String Input Binding

Source: https://pkg.go.dev/dagger.io/dagger

Provides a string input binding to the environment. It takes the input name, the string value, and a description.

```go
func (r *Env) WithStringInput(name string, value string, description string) *Env
```

--------------------------------

### Check.ResultEmoji

Source: https://pkg.go.dev/dagger.io/dagger

Gets an emoji representing the result of the check.

```APIDOC
## Check.ResultEmoji

### Description
Gets an emoji representing the result of the check.

### Method
ResultEmoji

### Endpoint
N/A (SDK function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **ctx** (context.Context) - The context for the operation.

### Request Example
```go
emoji, err := check.ResultEmoji(ctx)
```

### Response
#### Success Response (200)
- **string** - The emoji representing the check result.
- **error** (error) - An error if retrieving the emoji fails.

#### Response Example
```go
// Returns an emoji string like "✅" or an error
```
```

--------------------------------

### Create New Directory

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves this directory plus a new directory created at the given path. Use this to add an empty subdirectory to your structure.

```go
func (r *Directory) WithNewDirectory(path string, opts ...DirectoryWithNewDirectoryOpts) *Directory
```

--------------------------------

### DiffStat.OldPath

Source: https://pkg.go.dev/dagger.io/dagger

Gets the old path of a diff stat.

```APIDOC
## DiffStat.OldPath

### Description
Gets the old path of a diff stat.

### Method
N/A (This is a Go method, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.

### Response
#### Success Response
- Returns a string representing the old path.

### Request Example
N/A

### Response Example
N/A
```

--------------------------------

### ContainerWithFileOpts

Source: https://pkg.go.dev/dagger.io/dagger

Options for Container.WithFile. Specifies permissions, owner, and environment variable expansion for copying a single file into a container.

```go
type ContainerWithFileOpts struct {
	// Permissions of the new file. Example: 0600
	Permissions int
	// A user:group to set for the file.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}
```

--------------------------------

### ModuleSource.ConfigClients Method

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the clients generated for the module. Requires a context.

```go
func (r *ModuleSource) ConfigClients(ctx context.Context) ([]ModuleConfigClient, error)
```

--------------------------------

### Workspace.Address

Source: https://pkg.go.dev/dagger.io/dagger

Gets the canonical Dagger address of the workspace directory.

```APIDOC
## Workspace.Address

### Description
Gets the canonical Dagger address of the workspace directory.

### Method
GET

### Endpoint
/workspace/address

### Parameters
#### Query Parameters
- **ctx** (context.Context) - Required - The context for the request.

### Response
#### Success Response (200)
- **address** (string) - The canonical Dagger address of the workspace directory.
- **error** (error) - An error if the address could not be retrieved.
```

--------------------------------

### Address Directory Method

Source: https://pkg.go.dev/dagger.io/dagger

Loads a directory from the given address, with optional configuration options.

```go
func (r *Address) Directory(opts ...AddressDirectoryOpts) *Directory
```

--------------------------------

### Get TypeDef Name

Source: https://pkg.go.dev/dagger.io/dagger

The canonical non-optional name of the type.

```go
func (r *TypeDef) Name(ctx context.Context) (string, error)
```

--------------------------------

### ListTypeDef ID Method

Source: https://pkg.go.dev/dagger.io/dagger

Gets the unique identifier for this ListTypeDef.

```go
func (r *ListTypeDef) ID(ctx context.Context) (ID, error)
```

--------------------------------

### Load Directory as Module Source

Source: https://pkg.go.dev/dagger.io/dagger

Loads a directory as a Dagger module source. Use DirectoryAsModuleSourceOpts for configuration.

```go
func (r *Directory) AsModuleSource(opts ...DirectoryAsModuleSourceOpts) *ModuleSource
```

--------------------------------

### Label ID Method

Source: https://pkg.go.dev/dagger.io/dagger

Gets the unique identifier for this Label.

```go
func (r *Label) ID(ctx context.Context) (ID, error)
```

--------------------------------

### Module GeneratedContextDirectory Method

Source: https://pkg.go.dev/dagger.io/dagger

Returns the generated files and directories based on the module's source context directory.

```go
func (r *Module) GeneratedContextDirectory() *Directory
```

--------------------------------

### LLMTokenUsage ID Method

Source: https://pkg.go.dev/dagger.io/dagger

Gets the unique identifier for this LLMTokenUsage.

```go
func (r *LLMTokenUsage) ID(ctx context.Context) (ID, error)
```

--------------------------------

### DirectoryWithFilesOpts Structure

Source: https://pkg.go.dev/dagger.io/dagger

Defines options for copying multiple files, specifying permissions.

```go
type DirectoryWithFilesOpts struct {
	// Permission given to the copied files (e.g., 0600).
	Permissions int
}
```

--------------------------------

### Get Directory ID

Source: https://pkg.go.dev/dagger.io/dagger

Returns a unique identifier for this Directory.

```go
func (r *Directory) ID(ctx context.Context) (ID, error)
```

--------------------------------

### Example Usage of Container 'With' Function

Source: https://pkg.go.dev/dagger.io/dagger

Demonstrates a basic usage of the 'With' function, which applies a modification to a container.

```text
Output:
bar

```

--------------------------------

### Up.With Method

Source: https://pkg.go.dev/dagger.io/dagger

Applies a function to the current Up service. Useful for reusability and maintaining call chains.

```go
func (r *Up) With(f WithUpFunc) *Up
```

--------------------------------

### DiffStat.RemovedLines

Source: https://pkg.go.dev/dagger.io/dagger

Gets the number of removed lines for a diff stat.

```APIDOC
## DiffStat.RemovedLines

### Description
Gets the number of removed lines for a diff stat.

### Method
N/A (This is a Go method, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.

### Response
#### Success Response
- Returns an integer representing the number of removed lines.

### Request Example
N/A

### Response Example
N/A
```

--------------------------------

### ContainerWithDefaultTerminalCmdOpts Configuration

Source: https://pkg.go.dev/dagger.io/dagger

Options for Container.WithDefaultTerminalCmd. Use ExperimentalPrivilegedNesting for Dagger access and InsecureRootCapabilities for root privileges (use with caution).

```go
type ContainerWithDefaultTerminalCmdOpts struct {
	// Provides Dagger access to the executed command.
	ExperimentalPrivilegedNesting bool
	// Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
	InsecureRootCapabilities bool
}
```

--------------------------------

### Up.OriginalModule Method

Source: https://pkg.go.dev/dagger.io/dagger

Returns the original module in which the service was defined.

```go
func (r *Up) OriginalModule() *Module
```

--------------------------------

### DiffStat.AddedLines

Source: https://pkg.go.dev/dagger.io/dagger

Gets the number of added lines for a diff stat.

```APIDOC
## DiffStat.AddedLines

### Description
Gets the number of added lines for a diff stat.

### Method
N/A (This is a Go method, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
- **ctx** (context.Context) - Required - The context for the operation.

### Response
#### Success Response
- Returns an integer representing the number of added lines.

### Request Example
N/A

### Response Example
N/A
```

--------------------------------

### Find File or Directory in Workspace

Source: https://pkg.go.dev/dagger.io/dagger

Searches for a file or directory by walking up from a specified start path within the workspace. Returns the absolute workspace path if found, or null if not found. Relative start paths resolve from the workspace directory, and the search stops at the workspace boundary.

```go
func (r *Workspace) FindUp(ctx context.Context, name string, opts ...WorkspaceFindUpOpts) (string, error)
```

--------------------------------

### DirectoryWithFileOpts Structure

Source: https://pkg.go.dev/dagger.io/dagger

Defines options for copying files, specifying permissions and owner.

```go
type DirectoryWithFileOpts struct {
	// Permission given to the copied file (e.g., 0600).
	Permissions int
	// A user:group to set for the copied directory and its contents.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
}
```

--------------------------------

### Service Up Options

Source: https://pkg.go.dev/dagger.io/dagger

Options for bringing a service up, including port forwarding and random port assignment.

```go
type ServiceUpOpts struct {
	// List of frontend/backend port mappings to forward.
	//
	// Frontend is the port accepting traffic on the host, backend is the service port.
	Ports []PortForward
	// Bind each tunnel port to a random port on the host.
	Random bool
}
```

--------------------------------

### SearchSubmatch.Start

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the start offset of a match within the matched lines.

```APIDOC
## SearchSubmatch.Start

### Description
Retrieves the start offset of a match within the matched lines.

### Method
(Not applicable, this is a method on a Go struct)

### Endpoint
(Not applicable, this is a method on a Go struct)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(None)

### Response
#### Success Response
- **int**: The start offset within the matched lines.

#### Response Example
(None)
```

--------------------------------

### HTTPOpts Structure for Query.HTTP

Source: https://pkg.go.dev/dagger.io/dagger

Contains options for downloading content via HTTP, including name, permissions, checksum, authentication, and experimental service host.

```go
type HTTPOpts struct {
	// File name to use for the file. Defaults to the last part of the URL.
	Name string
	// Permissions to set on the file.
	Permissions int
	// Expected digest of the downloaded content (e.g., "sha256:...").
	Checksum string
	// Secret used to populate the Authorization HTTP header
	AuthHeader *Secret
	// A service which must be started before the URL is fetched.
	ExperimentalServiceHost *Service
}
```

--------------------------------

### ModuleSource.WithUpdatedClients

Source: https://pkg.go.dev/dagger.io/dagger

Updates one or more clients. This method is available starting from v0.18.19.

```APIDOC
## ModuleSource.WithUpdatedClients

### Description
Updates one or more clients.

### Method
*ModuleSource.WithUpdatedClients*

### Parameters
#### Path Parameters
- **clients** ([]string) - Description: A slice of client names to update.
```

--------------------------------

### ModuleSource.WithUpdateToolchains

Source: https://pkg.go.dev/dagger.io/dagger

Updates one or more toolchains. This method is available starting from v0.19.4.

```APIDOC
## ModuleSource.WithUpdateToolchains

### Description
Updates one or more toolchains.

### Method
*ModuleSource.WithUpdateToolchains*

### Parameters
#### Path Parameters
- **toolchains** ([]string) - Description: A slice of toolchain names to update.
```

--------------------------------

### Configure Service with Function

Source: https://pkg.go.dev/dagger.io/dagger

Calls the provided function with the current Service. Useful for reusability and readability by not breaking the calling chain.

```go
func (r *Service) With(f WithServiceFunc) *Service
```

--------------------------------

### Get File Name

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the name of the file. Requires a context.

```go
func (r *File) Name(ctx context.Context) (string, error)
```

--------------------------------

### Get Workspace Directory

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the workspace directory associated with the environment.

```go
func (r *Env) Workspace() *Directory
```

--------------------------------

### Query.File

Source: https://pkg.go.dev/dagger.io/dagger

Creates a file with the specified name, contents, and options.

```APIDOC
## Query.File

### Description
Creates a file with the specified name, contents, and options.

### Method
N/A (This is a Go function signature, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
- **name** (string) - The name of the file.
- **contents** (string) - The content of the file.
- **opts** ([]FileOpts) - Optional configuration options for the file.

#### Response Example
N/A
```

--------------------------------

### EnumValueTypeDef.XXX_GraphQLType

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name.

```APIDOC
## EnumValueTypeDef.XXX_GraphQLType

### Description
Internal function to get the native GraphQL type name.

### Method
(Not applicable, Go function)

### Endpoint
(Not applicable, Go function)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(Not applicable)

### Response
#### Success Response
- **string**: The native GraphQL type name.

#### Response Example
(Not applicable)
```

--------------------------------

### WithServiceBinding

Source: https://pkg.go.dev/dagger.io/dagger

Establishes a runtime dependency from a container to a network service. The service will be started automatically when needed and detached when no longer required.

```APIDOC
## WithServiceBinding

### Description
Establish a runtime dependency from a container to a network service. The service will be started automatically when needed and detached when it is no longer needed, executing the default command if none is set. The service will be reachable from the container via the provided hostname alias. The service dependency will also convey to any files or directories produced by the container.

### Method
`WithServiceBinding`

### Parameters
#### Path Parameters
- **alias** (string) - Required - The hostname alias for the service within the container.
- **service** (*Service) - Required - The service to bind.

### Response
- **Container** - A new container with the service binding established.
```

--------------------------------

### EnumTypeDef.XXX_GraphQLType

Source: https://pkg.go.dev/dagger.io/dagger

Internal function to get the native GraphQL type name.

```APIDOC
## EnumTypeDef.XXX_GraphQLType

### Description
Internal function to get the native GraphQL type name.

### Method
(Not applicable, Go function)

### Endpoint
(Not applicable, Go function)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(Not applicable)

### Response
#### Success Response
- **string**: The native GraphQL type name.

#### Response Example
(Not applicable)
```

--------------------------------

### CurrentModule.GeneratedContextDirectory Method

Source: https://pkg.go.dev/dagger.io/dagger

Returns the generated files and directories created on top of the module's context directory.

```go
func (r *CurrentModule) GeneratedContextDirectory() *Directory
```

--------------------------------

### Get Default Arguments

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the container's default arguments.

```go
func (r *Container) DefaultArgs(ctx context.Context) ([]string, error)

```

--------------------------------

### CacheSharingMode Name Method

Source: https://pkg.go.dev/dagger.io/dagger

Gets the name of a CacheSharingMode. Added in v0.18.11.

```go
func (v CacheSharingMode) Name() string
```

--------------------------------

### Host Directory Method

Source: https://pkg.go.dev/dagger.io/dagger

Accesses a directory on the host.

```go
func (r *Host) Directory(path string, opts ...HostDirectoryOpts) *Directory
```

--------------------------------

### Directory.Stat

Source: https://pkg.go.dev/dagger.io/dagger

Gets the stat information for a file or directory at a given path.

```APIDOC
## Directory.Stat

### Description
Gets the stat information for a file or directory at a given path.

### Method
N/A (This is a Go method, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
- **path** (string) - Required - The path to the file or directory.
- **opts** (DirectoryStatOpts) - Optional - Options for retrieving stat information.

### Response
#### Success Response
- Returns a pointer to a Stat object containing file/directory metadata.

### Request Example
N/A

### Response Example
N/A
```

--------------------------------

### Function Description Method

Source: https://pkg.go.dev/dagger.io/dagger

Retrieves the documentation string for the function, if any.

```go
func (r *Function) Description(ctx context.Context) (string, error)

```
Tokens:
Raw