Documentation ¶
Index ¶
- func Serve(server any)
- type BuildArg
- type CacheID
- type CacheSharingMode
- type CacheVolume
- type Client
- func (r *Client) CacheVolume(key string) *CacheVolume
- func (c *Client) Close() error
- func (r *Client) Container(opts ...ContainerOpts) *Container
- func (r *Client) DefaultPlatform(ctx context.Context) (Platform, error)
- func (r *Client) Directory(opts ...DirectoryOpts) *Directory
- func (c *Client) Do(ctx context.Context, req *Request, resp *Response) error
- func (r *Client) File(id FileID) *File
- func (r *Client) Git(url string, opts ...GitOpts) *GitRepository
- func (r *Client) HTTP(url string) *File
- func (r *Client) Host() *Host
- func (r *Client) Pipeline(name string, opts ...PipelineOpts) *Client
- func (r *Client) Project(name string) *Project
- func (r *Client) Secret(id SecretID) *Secret
- func (r *Client) Socket(opts ...SocketOpts) *Socket
- type ClientOpt
- type Container
- func (r *Container) Build(context *Directory, opts ...ContainerBuildOpts) *Container
- func (r *Container) DefaultArgs(ctx context.Context) ([]string, error)
- func (r *Container) Directory(path string) *Directory
- func (r *Container) Entrypoint(ctx context.Context) ([]string, error)
- func (r *Container) EnvVariable(ctx context.Context, name string) (string, error)
- func (r *Container) EnvVariables(ctx context.Context) ([]EnvVariable, error)
- func (r *Container) Exec(opts ...ContainerExecOpts) *Containerdeprecated
- func (r *Container) ExitCode(ctx context.Context) (int, error)
- func (r *Container) Export(ctx context.Context, path string, opts ...ContainerExportOpts) (bool, error)
- func (r *Container) FS() *Directorydeprecated
- func (r *Container) File(path string) *File
- func (r *Container) From(address string) *Container
- func (r *Container) ID(ctx context.Context) (ContainerID, error)
- func (r *Container) Label(ctx context.Context, name string) (string, error)
- func (r *Container) Labels(ctx context.Context) ([]Label, error)
- func (r *Container) Mounts(ctx context.Context) ([]string, error)
- func (r *Container) Pipeline(name string, opts ...ContainerPipelineOpts) *Container
- func (r *Container) Platform(ctx context.Context) (Platform, error)
- func (r *Container) Publish(ctx context.Context, address string, opts ...ContainerPublishOpts) (string, error)
- func (r *Container) Rootfs() *Directory
- func (r *Container) Stderr(ctx context.Context) (string, error)
- func (r *Container) Stdout(ctx context.Context) (string, error)
- func (r *Container) User(ctx context.Context) (string, error)
- func (r *Container) WithDefaultArgs(opts ...ContainerWithDefaultArgsOpts) *Container
- func (r *Container) WithDirectory(path string, directory *Directory, opts ...ContainerWithDirectoryOpts) *Container
- func (r *Container) WithEntrypoint(args []string) *Container
- func (r *Container) WithEnvVariable(name string, value string) *Container
- func (r *Container) WithExec(args []string, opts ...ContainerWithExecOpts) *Container
- func (r *Container) WithFS(id *Directory) *Containerdeprecated
- func (r *Container) WithFile(path string, source *File, opts ...ContainerWithFileOpts) *Container
- func (r *Container) WithLabel(name string, value string) *Container
- func (r *Container) WithMountedCache(path string, cache *CacheVolume, opts ...ContainerWithMountedCacheOpts) *Container
- func (r *Container) WithMountedDirectory(path string, source *Directory) *Container
- func (r *Container) WithMountedFile(path string, source *File) *Container
- func (r *Container) WithMountedSecret(path string, source *Secret) *Container
- func (r *Container) WithMountedTemp(path string) *Container
- func (r *Container) WithNewFile(path string, opts ...ContainerWithNewFileOpts) *Container
- func (r *Container) WithRegistryAuth(address string, username string, secret *Secret) *Container
- func (r *Container) WithRootfs(id *Directory) *Container
- func (r *Container) WithSecretVariable(name string, secret *Secret) *Container
- func (r *Container) WithUnixSocket(path string, source *Socket) *Container
- func (r *Container) WithUser(name string) *Container
- func (r *Container) WithWorkdir(path string) *Container
- func (r *Container) WithoutEnvVariable(name string) *Container
- func (r *Container) WithoutLabel(name string) *Container
- func (r *Container) WithoutMount(path string) *Container
- func (r *Container) WithoutRegistryAuth(address string) *Container
- func (r *Container) WithoutUnixSocket(path string) *Container
- func (r *Container) Workdir(ctx context.Context) (string, error)
- func (r *Container) XXX_GraphQLID(ctx context.Context) (string, error)
- func (r *Container) XXX_GraphQLType() string
- type ContainerBuildOpts
- type ContainerExecOpts
- type ContainerExportOpts
- type ContainerID
- type ContainerOpts
- type ContainerPipelineOpts
- type ContainerPublishOpts
- type ContainerWithDefaultArgsOpts
- type ContainerWithDirectoryOpts
- type ContainerWithExecOpts
- type ContainerWithFileOpts
- type ContainerWithMountedCacheOpts
- type ContainerWithNewFileOpts
- type Directory
- func (r *Directory) Diff(other *Directory) *Directory
- func (r *Directory) Directory(path string) *Directory
- func (r *Directory) DockerBuild(opts ...DirectoryDockerBuildOpts) *Container
- func (r *Directory) Entries(ctx context.Context, opts ...DirectoryEntriesOpts) ([]string, error)
- func (r *Directory) Export(ctx context.Context, path string) (bool, error)
- func (r *Directory) File(path string) *File
- func (r *Directory) ID(ctx context.Context) (DirectoryID, error)
- func (r *Directory) LoadProject(configPath string) *Project
- func (r *Directory) Pipeline(name string, opts ...DirectoryPipelineOpts) *Directory
- func (r *Directory) WithDirectory(path string, directory *Directory, opts ...DirectoryWithDirectoryOpts) *Directory
- func (r *Directory) WithFile(path string, source *File, opts ...DirectoryWithFileOpts) *Directory
- func (r *Directory) WithNewDirectory(path string, opts ...DirectoryWithNewDirectoryOpts) *Directory
- func (r *Directory) WithNewFile(path string, contents string, opts ...DirectoryWithNewFileOpts) *Directory
- func (r *Directory) WithTimestamps(timestamp int) *Directory
- func (r *Directory) WithoutDirectory(path string) *Directory
- func (r *Directory) WithoutFile(path string) *Directory
- func (r *Directory) XXX_GraphQLID(ctx context.Context) (string, error)
- func (r *Directory) XXX_GraphQLType() string
- type DirectoryDockerBuildOpts
- type DirectoryEntriesOpts
- type DirectoryID
- type DirectoryOpts
- type DirectoryPipelineOpts
- type DirectoryWithDirectoryOpts
- type DirectoryWithFileOpts
- type DirectoryWithNewDirectoryOpts
- type DirectoryWithNewFileOpts
- type EnvVariable
- type File
- func (r *File) Contents(ctx context.Context) (string, error)
- func (r *File) Export(ctx context.Context, path string) (bool, error)
- func (r *File) ID(ctx context.Context) (FileID, error)
- func (r *File) Secret() *Secret
- func (r *File) Size(ctx context.Context) (int, error)
- func (r *File) WithTimestamps(timestamp int) *File
- func (r *File) XXX_GraphQLID(ctx context.Context) (string, error)
- func (r *File) XXX_GraphQLType() string
- type FileID
- type GitOpts
- type GitRef
- type GitRefTreeOpts
- type GitRepository
- type Host
- type HostDirectoryOpts
- type HostVariable
- type HostWorkdirOpts
- type Label
- type PipelineOpts
- type Platform
- type Project
- func (r *Project) Extensions(ctx context.Context) ([]Project, error)
- func (r *Project) GeneratedCode() *Directory
- func (r *Project) Install(ctx context.Context) (bool, error)
- func (r *Project) Name(ctx context.Context) (string, error)
- func (r *Project) SDK(ctx context.Context) (string, error)
- func (r *Project) Schema(ctx context.Context) (string, error)
- type Request
- type Response
- type Secret
- type SecretID
- type Socket
- type SocketID
- type SocketOpts
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CacheSharingMode ¶ added in v0.4.5
type CacheSharingMode string
const ( Locked CacheSharingMode = "LOCKED" Private CacheSharingMode = "PRIVATE" )
type CacheVolume ¶
type CacheVolume struct {
// contains filtered or unexported fields
}
A directory whose contents persist across runs.
func (*CacheVolume) XXX_GraphQLID ¶ added in v0.4.0
func (r *CacheVolume) XXX_GraphQLID(ctx context.Context) (string, error)
XXX_GraphQLID is an internal function. It returns the underlying type ID
func (*CacheVolume) XXX_GraphQLType ¶ added in v0.4.0
func (r *CacheVolume) XXX_GraphQLType() string
XXX_GraphQLType is an internal function. It returns the native GraphQL type name
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the Dagger Engine Client
func (*Client) CacheVolume ¶ added in v0.4.4
func (r *Client) CacheVolume(key string) *CacheVolume
Constructs a cache volume for a given cache key.
func (*Client) Container ¶ added in v0.4.4
func (r *Client) Container(opts ...ContainerOpts) *Container
Loads a container from ID. Null ID returns an empty container (scratch). Optional platform argument initializes new containers to execute and publish as that platform. Platform defaults to that of the builder's host.
func (*Client) DefaultPlatform ¶ added in v0.4.4
The default platform of the builder.
func (*Client) Directory ¶ added in v0.4.4
func (r *Client) Directory(opts ...DirectoryOpts) *Directory
Load a directory by ID. No argument produces an empty directory.
func (*Client) Git ¶ added in v0.4.4
func (r *Client) Git(url string, opts ...GitOpts) *GitRepository
Queries a git repository.
func (*Client) Pipeline ¶ added in v0.4.4
func (r *Client) Pipeline(name string, opts ...PipelineOpts) *Client
Creates a named sub-pipeline
func (*Client) Socket ¶ added in v0.4.4
func (r *Client) Socket(opts ...SocketOpts) *Socket
Loads a socket by its ID.
type ClientOpt ¶
type ClientOpt interface {
// contains filtered or unexported methods
}
ClientOpt holds a client option
func WithConfigPath ¶
WithConfigPath sets the engine config path
func WithLogOutput ¶
WithLogOutput sets the progress writer
func WithNoExtensions ¶
func WithNoExtensions() ClientOpt
WithNoExtensions disables installing extensions
type Container ¶
type Container struct {
// contains filtered or unexported fields
}
An OCI-compatible container, also known as a docker container.
Example ¶
package main import ( "context" "fmt" "dagger.io/dagger" ) func main() { ctx := context.Background() client, err := dagger.Connect(ctx) if err != nil { panic(err) } defer client.Close() alpine := client.Container().From("alpine:3.16.2") out, err := alpine.Exec(dagger.ContainerExecOpts{ Args: []string{"cat", "/etc/alpine-release"}, }).Stdout(ctx) if err != nil { panic(err) } fmt.Println(out) }
Output: 3.16.2
func (*Container) Build ¶
func (r *Container) Build(context *Directory, opts ...ContainerBuildOpts) *Container
Initializes this container from a Dockerfile build, using the context, a dockerfile file path and some additional buildArgs.
Example ¶
package main import ( "context" "fmt" "strings" "dagger.io/dagger" ) func main() { ctx := context.Background() client, err := dagger.Connect(ctx) if err != nil { panic(err) } defer client.Close() repo := client.Git("https://github.com/dagger/dagger"). Tag("v0.3.0"). Tree() daggerImg := client.Container().Build(repo) out, err := daggerImg.Exec(dagger.ContainerExecOpts{ Args: []string{"version"}, }).Stdout(ctx) if err != nil { panic(err) } words := strings.Split(strings.TrimSpace(out), " ") fmt.Println(words[0]) }
Output: dagger
func (*Container) DefaultArgs ¶
Retrieves default arguments for future commands.
func (*Container) Entrypoint ¶
Retrieves entrypoint to be prepended to the arguments of all commands.
func (*Container) EnvVariable ¶
Retrieves the value of the specified environment variable.
func (*Container) EnvVariables ¶
func (r *Container) EnvVariables(ctx context.Context) ([]EnvVariable, error)
Retrieves the list of environment variables passed to commands.
func (*Container) Exec
deprecated
func (r *Container) Exec(opts ...ContainerExecOpts) *Container
Retrieves this container after executing the specified command inside it.
Deprecated: Replaced by WithExec.
func (*Container) ExitCode ¶
Exit code of the last executed command. Zero means success. Null if no command has been executed.
func (*Container) Export ¶ added in v0.4.0
func (r *Container) Export(ctx context.Context, path string, opts ...ContainerExportOpts) (bool, error)
Writes the container as an OCI tarball to the destination file path on the host for the specified platformVariants. Return true on success.
func (*Container) From ¶
Initializes this container from the base image published at the given address.
func (*Container) ID ¶
func (r *Container) ID(ctx context.Context) (ContainerID, error)
A unique identifier for this container.
func (*Container) Pipeline ¶ added in v0.4.4
func (r *Container) Pipeline(name string, opts ...ContainerPipelineOpts) *Container
Creates a named sub-pipeline
func (*Container) Publish ¶
func (r *Container) Publish(ctx context.Context, address string, opts ...ContainerPublishOpts) (string, error)
Publishes this container as a new image to the specified address, for the platformVariants, returning a fully qualified ref.
func (*Container) Rootfs ¶ added in v0.4.1
Retrieves this container's root filesystem. Mounts are not included.
func (*Container) Stderr ¶
The error stream of the last executed command. Null if no command has been executed.
func (*Container) Stdout ¶
The output stream of the last executed command. Null if no command has been executed.
func (*Container) WithDefaultArgs ¶
func (r *Container) WithDefaultArgs(opts ...ContainerWithDefaultArgsOpts) *Container
Configures default arguments for future commands.
func (*Container) WithDirectory ¶ added in v0.4.2
func (r *Container) WithDirectory(path string, directory *Directory, opts ...ContainerWithDirectoryOpts) *Container
Retrieves this container plus a directory written at the given path.
func (*Container) WithEntrypoint ¶
Retrieves this container but with a different command entrypoint.
func (*Container) WithEnvVariable ¶
Retrieves this container plus the given environment variable.
Example ¶
package main import ( "context" "fmt" "dagger.io/dagger" ) func main() { ctx := context.Background() client, err := dagger.Connect(ctx) if err != nil { panic(err) } defer client.Close() container := client.Container().From("alpine:3.16.2") container = container.WithEnvVariable("FOO", "bar") out, err := container.Exec(dagger.ContainerExecOpts{ Args: []string{"sh", "-c", "echo $FOO"}, }).Stdout(ctx) if err != nil { panic(err) } fmt.Println(out) }
Output: bar
func (*Container) WithExec ¶ added in v0.4.1
func (r *Container) WithExec(args []string, opts ...ContainerWithExecOpts) *Container
Retrieves this container after executing the specified command inside it.
func (*Container) WithFile ¶ added in v0.4.2
func (r *Container) WithFile(path string, source *File, opts ...ContainerWithFileOpts) *Container
Retrieves this container plus the contents of the given file copied to the given path.
func (*Container) WithMountedCache ¶
func (r *Container) WithMountedCache(path string, cache *CacheVolume, opts ...ContainerWithMountedCacheOpts) *Container
Retrieves this container plus a cache volume mounted at the given path.
Example ¶
package main import ( "context" "fmt" "strconv" "time" "dagger.io/dagger" ) func main() { ctx := context.Background() client, err := dagger.Connect(ctx) if err != nil { panic(err) } defer client.Close() cacheKey := "example-cache" cache := client.CacheVolume(cacheKey) container := client.Container().From("alpine:3.16.2") container = container.WithMountedCache("/cache", cache) filename := time.Now().Format("2006-01-02-15-04-05") echoCmd := fmt.Sprintf("echo $0 >> /cache/%[1]v.txt; cat /cache/%[1]v.txt", filename) var out string for i := 0; i < 5; i++ { out, err = container.Exec(dagger.ContainerExecOpts{ Args: []string{"sh", "-c", echoCmd, strconv.Itoa(i)}, }).Stdout(ctx) if err != nil { panic(err) } } fmt.Printf("%q", out) }
Output: "0\n1\n2\n3\n4\n"
func (*Container) WithMountedDirectory ¶
Retrieves this container plus a directory mounted at the given path.
Example ¶
package main import ( "context" "fmt" "dagger.io/dagger" ) func main() { ctx := context.Background() client, err := dagger.Connect(ctx) if err != nil { panic(err) } defer client.Close() dir := client.Directory(). WithNewFile("hello.txt", "Hello, world!"). WithNewFile("goodbye.txt", "Goodbye, world!") container := client.Container().From("alpine:3.16.2") container = container.WithMountedDirectory("/mnt", dir) out, err := container.Exec(dagger.ContainerExecOpts{ Args: []string{"ls", "/mnt"}, }).Stdout(ctx) if err != nil { panic(err) } fmt.Printf("%q", out) }
Output: "goodbye.txt\nhello.txt\n"
func (*Container) WithMountedFile ¶
Retrieves this container plus a file mounted at the given path.
func (*Container) WithMountedSecret ¶
Retrieves this container plus a secret mounted into a file at the given path.
func (*Container) WithMountedTemp ¶
Retrieves this container plus a temporary directory mounted at the given path.
func (*Container) WithNewFile ¶ added in v0.4.2
func (r *Container) WithNewFile(path string, opts ...ContainerWithNewFileOpts) *Container
Retrieves this container plus a new file written at the given path.
func (*Container) WithRegistryAuth ¶ added in v0.4.5
Retrieves this container with a registry authentication for a given address.
func (*Container) WithRootfs ¶ added in v0.4.1
Initializes this container from this DirectoryID.
func (*Container) WithSecretVariable ¶
Retrieves this container plus an env variable containing the given secret.
func (*Container) WithUnixSocket ¶ added in v0.4.2
Retrieves this container plus a socket forwarded to the given Unix socket path.
func (*Container) WithWorkdir ¶
Retrieves this container with a different working directory.
func (*Container) WithoutEnvVariable ¶
Retrieves this container minus the given environment variable.
func (*Container) WithoutLabel ¶ added in v0.4.4
Retrieves this container minus the given environment label.
func (*Container) WithoutMount ¶
Retrieves this container after unmounting everything at the given path.
func (*Container) WithoutRegistryAuth ¶ added in v0.4.5
Retrieves this container without the registry authentication of a given address.
func (*Container) WithoutUnixSocket ¶ added in v0.4.2
Retrieves this container with a previously added Unix socket removed.
func (*Container) XXX_GraphQLID ¶ added in v0.4.0
XXX_GraphQLID is an internal function. It returns the underlying type ID
func (*Container) XXX_GraphQLType ¶ added in v0.4.0
XXX_GraphQLType is an internal function. It returns the native GraphQL type name
type ContainerBuildOpts ¶
type ContainerBuildOpts struct { // Path to the Dockerfile to use. // Defaults to './Dockerfile'. Dockerfile string // Additional build arguments. BuildArgs []BuildArg // Target build stage to build. Target string }
ContainerBuildOpts contains options for Container.Build
type ContainerExecOpts ¶
type ContainerExecOpts struct { // Command to run instead of the container's default command. Args []string // Content to write to the command's standard input before closing. Stdin string // Redirect the command's standard output to a file in the container. RedirectStdout string // Redirect the command's standard error to a file in the container. RedirectStderr string // Provide dagger access to the executed command. // Do not use this option unless you trust the command being executed. // The command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM. ExperimentalPrivilegedNesting bool }
ContainerExecOpts contains options for Container.Exec
type ContainerExportOpts ¶ added in v0.4.0
type ContainerExportOpts struct { // Identifiers for other platform specific containers. // Used for multi-platform image. PlatformVariants []*Container }
ContainerExportOpts contains options for Container.Export
type ContainerID ¶
type ContainerID string
A unique container identifier. Null designates an empty container (scratch).
type ContainerOpts ¶
type ContainerOpts struct { ID ContainerID Platform Platform }
ContainerOpts contains options for Query.Container
type ContainerPipelineOpts ¶ added in v0.4.4
type ContainerPipelineOpts struct {
Description string
}
ContainerPipelineOpts contains options for Container.Pipeline
type ContainerPublishOpts ¶ added in v0.4.0
type ContainerPublishOpts struct { // Identifiers for other platform specific containers. // Used for multi-platform image. PlatformVariants []*Container }
ContainerPublishOpts contains options for Container.Publish
type ContainerWithDefaultArgsOpts ¶
type ContainerWithDefaultArgsOpts struct {
Args []string
}
ContainerWithDefaultArgsOpts contains options for Container.WithDefaultArgs
type ContainerWithDirectoryOpts ¶ added in v0.4.2
ContainerWithDirectoryOpts contains options for Container.WithDirectory
type ContainerWithExecOpts ¶ added in v0.4.1
type ContainerWithExecOpts struct { // Content to write to the command's standard input before closing. Stdin string // Redirect the command's standard output to a file in the container. RedirectStdout string // Redirect the command's standard error to a file in the container. RedirectStderr string // Provide dagger access to the executed command. // Do not use this option unless you trust the command being executed. // The command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM. ExperimentalPrivilegedNesting bool }
ContainerWithExecOpts contains options for Container.WithExec
type ContainerWithFileOpts ¶ added in v0.4.3
type ContainerWithFileOpts struct {
Permissions int
}
ContainerWithFileOpts contains options for Container.WithFile
type ContainerWithMountedCacheOpts ¶
type ContainerWithMountedCacheOpts struct { // Directory to use as the cache volume's root. Source *Directory // Sharing mode of the cache volume. Sharing CacheSharingMode }
ContainerWithMountedCacheOpts contains options for Container.WithMountedCache
type ContainerWithNewFileOpts ¶ added in v0.4.2
ContainerWithNewFileOpts contains options for Container.WithNewFile
type Directory ¶
type Directory struct {
// contains filtered or unexported fields
}
A directory.
Example ¶
package main import ( "context" "fmt" "dagger.io/dagger" ) func main() { ctx := context.Background() client, err := dagger.Connect(ctx) if err != nil { panic(err) } defer client.Close() dir := client.Directory(). WithNewFile("hello.txt", "Hello, world!"). WithNewFile("goodbye.txt", "Goodbye, world!") entries, err := dir.Entries(ctx) if err != nil { panic(err) } fmt.Println(entries) }
Output: [goodbye.txt hello.txt]
func (*Directory) DockerBuild ¶ added in v0.4.2
func (r *Directory) DockerBuild(opts ...DirectoryDockerBuildOpts) *Container
Builds a new Docker container from this directory.
func (*Directory) Export ¶ added in v0.4.0
Writes the contents of the directory to a path on the host.
func (*Directory) ID ¶
func (r *Directory) ID(ctx context.Context) (DirectoryID, error)
The content-addressed identifier of the directory.
func (*Directory) LoadProject ¶
load a project's metadata
func (*Directory) Pipeline ¶ added in v0.4.4
func (r *Directory) Pipeline(name string, opts ...DirectoryPipelineOpts) *Directory
Creates a named sub-pipeline.
func (*Directory) WithDirectory ¶
func (r *Directory) WithDirectory(path string, directory *Directory, opts ...DirectoryWithDirectoryOpts) *Directory
Retrieves this directory plus a directory written at the given path.
func (*Directory) WithFile ¶ added in v0.4.0
func (r *Directory) WithFile(path string, source *File, opts ...DirectoryWithFileOpts) *Directory
Retrieves this directory plus the contents of the given file copied to the given path.
func (*Directory) WithNewDirectory ¶ added in v0.4.0
func (r *Directory) WithNewDirectory(path string, opts ...DirectoryWithNewDirectoryOpts) *Directory
Retrieves this directory plus a new directory created at the given path.
func (*Directory) WithNewFile ¶
func (r *Directory) WithNewFile(path string, contents string, opts ...DirectoryWithNewFileOpts) *Directory
Retrieves this directory plus a new file written at the given path.
func (*Directory) WithTimestamps ¶ added in v0.4.3
Retrieves this directory with all file/dir timestamps set to the given time, in seconds from the Unix epoch.
func (*Directory) WithoutDirectory ¶
Retrieves this directory with the directory at the given path removed.
func (*Directory) WithoutFile ¶
Retrieves this directory with the file at the given path removed.
func (*Directory) XXX_GraphQLID ¶ added in v0.4.0
XXX_GraphQLID is an internal function. It returns the underlying type ID
func (*Directory) XXX_GraphQLType ¶ added in v0.4.0
XXX_GraphQLType is an internal function. It returns the native GraphQL type name
type DirectoryDockerBuildOpts ¶ added in v0.4.2
type DirectoryDockerBuildOpts struct { // Path to the Dockerfile to use. // Defaults to './Dockerfile'. Dockerfile string // The platform to build. Platform Platform // Additional build arguments. BuildArgs []BuildArg // Target build stage to build. Target string }
DirectoryDockerBuildOpts contains options for Directory.DockerBuild
type DirectoryEntriesOpts ¶
type DirectoryEntriesOpts struct {
Path string
}
DirectoryEntriesOpts contains options for Directory.Entries
type DirectoryOpts ¶
type DirectoryOpts struct {
ID DirectoryID
}
DirectoryOpts contains options for Query.Directory
type DirectoryPipelineOpts ¶ added in v0.4.4
type DirectoryPipelineOpts struct {
Description string
}
DirectoryPipelineOpts contains options for Directory.Pipeline
type DirectoryWithDirectoryOpts ¶ added in v0.4.0
type DirectoryWithDirectoryOpts struct { // Exclude artifacts that match the given pattern. // (e.g. ["node_modules/", ".git*"]). Exclude []string // Include only artifacts that match the given pattern. // (e.g. ["app/", "package.*"]). Include []string }
DirectoryWithDirectoryOpts contains options for Directory.WithDirectory
type DirectoryWithFileOpts ¶ added in v0.4.3
type DirectoryWithFileOpts struct {
Permissions int
}
DirectoryWithFileOpts contains options for Directory.WithFile
type DirectoryWithNewDirectoryOpts ¶ added in v0.4.3
type DirectoryWithNewDirectoryOpts struct {
Permissions int
}
DirectoryWithNewDirectoryOpts contains options for Directory.WithNewDirectory
type DirectoryWithNewFileOpts ¶
type DirectoryWithNewFileOpts struct {
Permissions int
}
DirectoryWithNewFileOpts contains options for Directory.WithNewFile
type EnvVariable ¶
type EnvVariable struct {
// contains filtered or unexported fields
}
A simple key value object that represents an environment variable.
type File ¶
type File struct {
// contains filtered or unexported fields
}
A file.
func (*File) WithTimestamps ¶ added in v0.4.3
Retrieves this file with its created/modified timestamps set to the given time, in seconds from the Unix epoch.
func (*File) XXX_GraphQLID ¶ added in v0.4.0
XXX_GraphQLID is an internal function. It returns the underlying type ID
func (*File) XXX_GraphQLType ¶ added in v0.4.0
XXX_GraphQLType is an internal function. It returns the native GraphQL type name
type GitOpts ¶ added in v0.4.1
type GitOpts struct {
KeepGitDir bool
}
GitOpts contains options for Query.Git
type GitRef ¶
type GitRef struct {
// contains filtered or unexported fields
}
A git ref (tag, branch or commit).
func (*GitRef) Tree ¶
func (r *GitRef) Tree(opts ...GitRefTreeOpts) *Directory
The filesystem tree at this ref.
type GitRefTreeOpts ¶ added in v0.4.2
GitRefTreeOpts contains options for GitRef.Tree
type GitRepository ¶
type GitRepository struct {
// contains filtered or unexported fields
}
A git repository.
Example ¶
package main import ( "context" "fmt" "strings" "dagger.io/dagger" ) func main() { ctx := context.Background() client, err := dagger.Connect(ctx) if err != nil { panic(err) } defer client.Close() readme, err := client.Git("https://github.com/dagger/dagger"). Tag("v0.3.0"). Tree().File("README.md").Contents(ctx) if err != nil { panic(err) } lines := strings.Split(strings.TrimSpace(readme), "\n") fmt.Println(lines[0]) }
Output: ## What is Dagger?
func (*GitRepository) Branch ¶
func (r *GitRepository) Branch(name string) *GitRef
Returns details on one branch.
func (*GitRepository) Branches ¶
func (r *GitRepository) Branches(ctx context.Context) ([]string, error)
Lists of branches on the repository.
func (*GitRepository) Commit ¶ added in v0.4.1
func (r *GitRepository) Commit(id string) *GitRef
Returns details on one commit.
func (*GitRepository) Tag ¶
func (r *GitRepository) Tag(name string) *GitRef
Returns details on one tag.
type Host ¶
type Host struct {
// contains filtered or unexported fields
}
Information about the host execution environment.
func (*Host) Directory ¶
func (r *Host) Directory(path string, opts ...HostDirectoryOpts) *Directory
Accesses a directory on the host.
Example ¶
package main import ( "context" "fmt" "strings" "dagger.io/dagger" ) func main() { ctx := context.Background() client, err := dagger.Connect(ctx, dagger.WithWorkdir(".")) if err != nil { panic(err) } defer client.Close() readme, err := client.Host().Directory(".").File("README.md").Contents(ctx) if err != nil { panic(err) } fmt.Printf("%v\n", strings.Contains(readme, "Dagger")) }
Output: true
func (*Host) EnvVariable ¶
func (r *Host) EnvVariable(name string) *HostVariable
Accesses an environment variable on the host.
func (*Host) UnixSocket ¶ added in v0.4.2
Accesses a Unix socket on the host.
func (*Host) Workdir
deprecated
func (r *Host) Workdir(opts ...HostWorkdirOpts) *Directory
Retrieves the current working directory on the host.
Deprecated: Use Directory with path set to '.' instead.
type HostDirectoryOpts ¶ added in v0.4.0
HostDirectoryOpts contains options for Host.Directory
type HostVariable ¶
type HostVariable struct {
// contains filtered or unexported fields
}
An environment variable on the host environment.
func (*HostVariable) Secret ¶
func (r *HostVariable) Secret() *Secret
A secret referencing the value of this variable.
type HostWorkdirOpts ¶ added in v0.4.0
HostWorkdirOpts contains options for Host.Workdir
type Label ¶ added in v0.4.4
type Label struct {
// contains filtered or unexported fields
}
A simple key value object that represents a label.
type PipelineOpts ¶ added in v0.4.4
type PipelineOpts struct {
Description string
}
PipelineOpts contains options for Query.Pipeline
type Platform ¶ added in v0.4.0
type Platform string
The platform config OS and architecture in a Container. The format is os/[platform]/[version] (e.g. darwin/arm64/v7, windows/amd64, linux/arm64).
type Project ¶
type Project struct {
// contains filtered or unexported fields
}
A set of scripts and/or extensions
func (*Project) Extensions ¶
extensions in this project
func (*Project) GeneratedCode ¶
Code files generated by the SDKs in the project
type Request ¶
type Request struct { // The literal string representing the GraphQL query, e.g. // `query myQuery { myField }`. Query string `json:"query"` // A JSON-marshalable value containing the variables to be sent // along with the query, or nil if there are none. Variables interface{} `json:"variables,omitempty"` // The GraphQL operation name. The server typically doesn't // require this unless there are multiple queries in the // document, but genqlient sets it unconditionally anyway. OpName string `json:"operationName"` }
Request contains all the values required to build queries executed by the graphql.Client.
Typically, GraphQL APIs will accept a JSON payload of the form
{"query": "query myQuery { ... }", "variables": {...}}`
and Request marshals to this format. However, MakeRequest may marshal the data in some other way desired by the backend.
type Response ¶
type Response struct { Data interface{} `json:"data"` Extensions map[string]interface{} `json:"extensions,omitempty"` Errors gqlerror.List `json:"errors,omitempty"` }
Response that contains data returned by the GraphQL API.
Typically, GraphQL APIs will return a JSON payload of the form
{"data": {...}, "errors": {...}}
It may additionally contain a key named "extensions", that might hold GraphQL protocol extensions. Extensions and Errors are optional, depending on the values returned by the server.
type Secret ¶
type Secret struct {
// contains filtered or unexported fields
}
A reference to a secret value, which can be handled more safely than the value itself.
func (*Secret) XXX_GraphQLID ¶ added in v0.4.0
XXX_GraphQLID is an internal function. It returns the underlying type ID
func (*Secret) XXX_GraphQLType ¶ added in v0.4.0
XXX_GraphQLType is an internal function. It returns the native GraphQL type name
type Socket ¶ added in v0.4.2
type Socket struct {
// contains filtered or unexported fields
}
func (*Socket) XXX_GraphQLID ¶ added in v0.4.2
XXX_GraphQLID is an internal function. It returns the underlying type ID
func (*Socket) XXX_GraphQLType ¶ added in v0.4.2
XXX_GraphQLType is an internal function. It returns the native GraphQL type name
type SocketOpts ¶ added in v0.4.2
type SocketOpts struct {
ID SocketID
}
SocketOpts contains options for Query.Socket