@dagger.io/dagger 0.3.0 → 0.3.2

package/dist/api/client.gen.d.ts

@@ -1,5 +1,5 @@
 /**
- * This file was auto-generated by `cloak clientgen`.
+ * This file was auto-generated by `client-gen`.
  * Do not make direct changes to the file.
  */
 import { GraphQLClient } from "graphql-request";
@@ -13,6 +13,7 @@ export type QueryTree = {
 interface ClientConfig {
     queryTree?: QueryTree[];
     host?: string;
+    sessionToken?: string;
 }
 declare class BaseClient {
     protected _queryTree: QueryTree[];
@@ -21,51 +22,79 @@ declare class BaseClient {
      * @defaultValue `127.0.0.1:8080`
      */
     clientHost: string;
+    sessionToken: string;
     /**
      * @hidden
      */
-    constructor({ queryTree, host }?: ClientConfig);
+    constructor({ queryTree, host, sessionToken }?: ClientConfig);
     /**
      * @hidden
      */
     get queryTree(): QueryTree[];
 }
+export type BuildArg = {
+    name: string;
+    value: string;
+};
 /**
- * A global cache volume identifier
+ * A global cache volume identifier.
  */
 export type CacheID = string;
 export type ContainerBuildOpts = {
+    /**
+     * Path to the Dockerfile to use.
+     * Defaults to './Dockerfile'.
+     */
     dockerfile?: string;
+    /**
+     * Additional build arguments.
+     */
+    buildArgs?: BuildArg[];
+    /**
+     * Target build stage to build.
+     */
+    target?: string;
 };
 export type ContainerExecOpts = {
     /**
-     * Command to run instead of the container's default command
+     * Command to run instead of the container's default command.
      */
     args?: string[];
     /**
-     * Content to write to the command's standard input before closing
+     * 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
+     * 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
+     * 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
+     * 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?: boolean;
 };
 export type ContainerExportOpts = {
-    platformVariants?: ContainerID[] | Container[];
+    /**
+     * Identifiers for other platform specific containers.
+     * Used for multi-platform image.
+     */
+    platformVariants?: Container[];
+};
+export type ContainerPipelineOpts = {
+    description?: string;
 };
 export type ContainerPublishOpts = {
-    platformVariants?: ContainerID[] | Container[];
+    /**
+     * Identifiers for other platform specific containers.
+     * Used for multi-platform image.
+     */
+    platformVariants?: Container[];
 };
 export type ContainerWithDefaultArgsOpts = {
     args?: string[];
@@ -76,29 +105,33 @@ export type ContainerWithDirectoryOpts = {
 };
 export type ContainerWithExecOpts = {
     /**
-     * Content to write to the command's standard input before closing
+     * 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
+     * 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
+     * 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
+     * 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?: boolean;
 };
+export type ContainerWithFileOpts = {
+    permissions?: number;
+};
 export type ContainerWithMountedCacheOpts = {
-    source?: DirectoryID | Directory;
+    source?: Directory;
 };
 export type ContainerWithNewFileOpts = {
     contents?: string;
+    permissions?: number;
 };
 /**
  * A unique container identifier. Null designates an empty container (scratch).
@@ -109,24 +142,62 @@ export type ContainerID = string;
  */
 export type DateTime = string;
 export type DirectoryDockerBuildOpts = {
+    /**
+     * 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;
 };
 export type DirectoryEntriesOpts = {
     path?: string;
 };
+export type DirectoryPipelineOpts = {
+    description?: string;
+};
 export type DirectoryWithDirectoryOpts = {
+    /**
+     * 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[];
 };
+export type DirectoryWithFileOpts = {
+    permissions?: number;
+};
+export type DirectoryWithNewDirectoryOpts = {
+    permissions?: number;
+};
+export type DirectoryWithNewFileOpts = {
+    permissions?: number;
+};
 /**
- * A content-addressed directory identifier
+ * A content-addressed directory identifier.
  */
 export type DirectoryID = string;
+/**
+ * A file identifier.
+ */
 export type FileID = string;
 export type GitRefTreeOpts = {
     sshKnownHosts?: string;
-    sshAuthSocket?: SocketID;
+    sshAuthSocket?: Socket;
 };
 export type HostDirectoryOpts = {
     exclude?: string[];
@@ -140,26 +211,33 @@ export type HostWorkdirOpts = {
  * The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
  */
 export type ID = 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).
+ */
 export type Platform = string;
 export type ClientContainerOpts = {
-    id?: ContainerID | Container;
+    id?: ContainerID;
     platform?: Platform;
 };
 export type ClientDirectoryOpts = {
-    id?: DirectoryID | Directory;
+    id?: DirectoryID;
 };
 export type ClientGitOpts = {
     keepGitDir?: boolean;
 };
+export type ClientPipelineOpts = {
+    description?: string;
+};
 export type ClientSocketOpts = {
     id?: SocketID;
 };
 /**
- * A unique identifier for a secret
+ * A unique identifier for a secret.
  */
 export type SecretID = string;
 /**
- * A content-addressed socket identifier
+ * A content-addressed socket identifier.
  */
 export type SocketID = string;
 export type __TypeEnumValuesOpts = {
@@ -169,44 +247,53 @@ export type __TypeFieldsOpts = {
     includeDeprecated?: boolean;
 };
 /**
- * A directory whose contents persist across runs
+ * A directory whose contents persist across runs.
  */
 export declare class CacheVolume extends BaseClient {
     id(): Promise<CacheID>;
 }
 /**
- * An OCI-compatible container, also known as a docker container
+ * An OCI-compatible container, also known as a docker container.
  */
 export declare class Container extends BaseClient {
     /**
-     * Initialize this container from a Dockerfile build
+     * Initializes this container from a Dockerfile build, using the context, a dockerfile file path and some additional buildArgs.
+     * @param context Directory context used by the Dockerfile.
+     * @param opts.dockerfile Path to the Dockerfile to use.
+  Defaults to './Dockerfile'.
+     * @param opts.buildArgs Additional build arguments.
+     * @param opts.target Target build stage to build.
      */
-    build(context: DirectoryID | Directory, opts?: ContainerBuildOpts): Container;
+    build(context: Directory, opts?: ContainerBuildOpts): Container;
     /**
-     * Default arguments for future commands
+     * Retrieves default arguments for future commands.
      */
     defaultArgs(): Promise<string[]>;
     /**
-     * Retrieve a directory at the given path. Mounts are included.
+     * Retrieves a directory at the given path. Mounts are included.
      */
     directory(path: string): Directory;
     /**
-     * Entrypoint to be prepended to the arguments of all commands
+     * Retrieves entrypoint to be prepended to the arguments of all commands.
      */
     entrypoint(): Promise<string[]>;
     /**
-     * The value of the specified environment variable
+     * Retrieves the value of the specified environment variable.
      */
     envVariable(name: string): Promise<string>;
     /**
-     * A list of environment variables passed to commands
+     * Retrieves the list of environment variables passed to commands.
      */
     envVariables(): Promise<EnvVariable[]>;
     /**
-     * This container after executing the specified command inside it
-     *
-     * @param opts optional params for exec
-     *
+     * Retrieves this container after executing the specified command inside it.
+     * @param opts.args Command to run instead of the container's default command.
+     * @param opts.stdin Content to write to the command's standard input before closing.
+     * @param opts.redirectStdout Redirect the command's standard output to a file in the container.
+     * @param opts.redirectStderr Redirect the command's standard error to a file in the container.
+     * @param opts.experimentalPrivilegedNesting 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.
      * @deprecated Replaced by withExec.
      */
     exec(opts?: ContainerExecOpts): Container;
@@ -216,42 +303,63 @@ export declare class Container extends BaseClient {
      */
     exitCode(): Promise<number>;
     /**
-     * Write the container as an OCI tarball to the destination file path on the host
+     * Writes the container as an OCI tarball to the destination file path on the host for the specified platformVariants.
+     * Return true on success.
+     * @param path Host's destination path.
+  Path can be relative to the engine's workdir or absolute.
+     * @param opts.platformVariants Identifiers for other platform specific containers.
+  Used for multi-platform image.
      */
     export(path: string, opts?: ContainerExportOpts): Promise<boolean>;
     /**
-     * Retrieve a file at the given path. Mounts are included.
+     * Retrieves a file at the given path. Mounts are included.
      */
     file(path: string): File;
     /**
-     * Initialize this container from the base image published at the given address
+     * Initializes this container from the base image published at the given address.
+     * @param address Image's address from its registry.
+  Formatted as [host]/[user]/[repo]:[tag] (e.g. docker.io/dagger/dagger:main).
      */
     from(address: string): Container;
     /**
-     * This container's root filesystem. Mounts are not included.
-     *
-     *
+     * Retrieves this container's root filesystem. Mounts are not included.
      * @deprecated Replaced by rootfs.
      */
     fs(): Directory;
     /**
-     * A unique identifier for this container
+     * A unique identifier for this container.
      */
     id(): Promise<ContainerID>;
     /**
-     * List of paths where a directory is mounted
+     * Retrieves the value of the specified label.
+     */
+    label(name: string): Promise<string>;
+    /**
+     * Retrieves the list of labels passed to container.
+     */
+    labels(): Promise<Label[]>;
+    /**
+     * Retrieves the list of paths where a directory is mounted.
      */
     mounts(): Promise<string[]>;
     /**
-     * The platform this container executes and publishes as
+     * Creates a named sub-pipeline
+     */
+    pipeline(name: string, opts?: ContainerPipelineOpts): Container;
+    /**
+     * The platform this container executes and publishes as.
      */
     platform(): Promise<Platform>;
     /**
-     * Publish this container as a new image, returning a fully qualified ref
+     * Publishes this container as a new image to the specified address, for the platformVariants, returning a fully qualified ref.
+     * @param address Registry's address to publish the image to.
+  Formatted as [host]/[user]/[repo]:[tag] (e.g. docker.io/dagger/dagger:main).
+     * @param opts.platformVariants Identifiers for other platform specific containers.
+  Used for multi-platform image.
      */
     publish(address: string, opts?: ContainerPublishOpts): Promise<string>;
     /**
-     * This container's root filesystem. Mounts are not included.
+     * Retrieves this container's root filesystem. Mounts are not included.
      */
     rootfs(): Directory;
     /**
@@ -265,131 +373,149 @@ export declare class Container extends BaseClient {
      */
     stdout(): Promise<string>;
     /**
-     * The user to be set for all commands
+     * Retrieves the user to be set for all commands.
      */
     user(): Promise<string>;
     /**
-     * Configures default arguments for future commands
+     * Configures default arguments for future commands.
      */
     withDefaultArgs(opts?: ContainerWithDefaultArgsOpts): Container;
     /**
-     * This container plus a directory written at the given path
+     * Retrieves this container plus a directory written at the given path.
      */
-    withDirectory(path: string, directory: DirectoryID | Directory, opts?: ContainerWithDirectoryOpts): Container;
+    withDirectory(path: string, directory: Directory, opts?: ContainerWithDirectoryOpts): Container;
     /**
-     * This container but with a different command entrypoint
+     * Retrieves this container but with a different command entrypoint.
      */
     withEntrypoint(args: string[]): Container;
     /**
-     * This container plus the given environment variable
+     * Retrieves this container plus the given environment variable.
      */
     withEnvVariable(name: string, value: string): Container;
     /**
-     * This container after executing the specified command inside it
+     * Retrieves this container after executing the specified command inside it.
+     * @param args Command to run instead of the container's default command.
+     * @param opts.stdin Content to write to the command's standard input before closing.
+     * @param opts.redirectStdout Redirect the command's standard output to a file in the container.
+     * @param opts.redirectStderr Redirect the command's standard error to a file in the container.
+     * @param opts.experimentalPrivilegedNesting 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.
      */
     withExec(args: string[], opts?: ContainerWithExecOpts): Container;
     /**
-     * Initialize this container from this DirectoryID
-     *
-     *
+     * Initializes this container from this DirectoryID.
      * @deprecated Replaced by withRootfs.
      */
-    withFS(id: DirectoryID | Directory): Container;
+    withFS(id: Directory): Container;
     /**
-     * This container plus the contents of the given file copied to the given path
+     * Retrieves this container plus the contents of the given file copied to the given path.
      */
-    withFile(path: string, source: FileID | File): Container;
+    withFile(path: string, source: File, opts?: ContainerWithFileOpts): Container;
     /**
-     * This container plus a cache volume mounted at the given path
+     * Retrieves this container plus the given label.
      */
-    withMountedCache(path: string, cache: CacheID | CacheVolume, opts?: ContainerWithMountedCacheOpts): Container;
+    withLabel(name: string, value: string): Container;
     /**
-     * This container plus a directory mounted at the given path
+     * Retrieves this container plus a cache volume mounted at the given path.
      */
-    withMountedDirectory(path: string, source: DirectoryID | Directory): Container;
+    withMountedCache(path: string, cache: CacheVolume, opts?: ContainerWithMountedCacheOpts): Container;
     /**
-     * This container plus a file mounted at the given path
+     * Retrieves this container plus a directory mounted at the given path.
      */
-    withMountedFile(path: string, source: FileID | File): Container;
+    withMountedDirectory(path: string, source: Directory): Container;
     /**
-     * This container plus a secret mounted into a file at the given path
+     * Retrieves this container plus a file mounted at the given path.
      */
-    withMountedSecret(path: string, source: SecretID | Secret): Container;
+    withMountedFile(path: string, source: File): Container;
     /**
-     * This container plus a temporary directory mounted at the given path
+     * Retrieves this container plus a secret mounted into a file at the given path.
+     */
+    withMountedSecret(path: string, source: Secret): Container;
+    /**
+     * Retrieves this container plus a temporary directory mounted at the given path.
      */
     withMountedTemp(path: string): Container;
     /**
-     * This container plus a new file written at the given path
+     * Retrieves this container plus a new file written at the given path.
      */
     withNewFile(path: string, opts?: ContainerWithNewFileOpts): Container;
     /**
-     * Initialize this container from this DirectoryID
+     * Initializes this container from this DirectoryID.
      */
-    withRootfs(id: DirectoryID | Directory): Container;
+    withRootfs(id: Directory): Container;
     /**
-     * This container plus an env variable containing the given secret
+     * Retrieves this container plus an env variable containing the given secret.
      */
-    withSecretVariable(name: string, secret: SecretID | Secret): Container;
+    withSecretVariable(name: string, secret: Secret): Container;
     /**
-     * This container plus a socket forwarded to the given Unix socket path
+     * Retrieves this container plus a socket forwarded to the given Unix socket path.
      */
-    withUnixSocket(path: string, source: SocketID): Container;
+    withUnixSocket(path: string, source: Socket): Container;
     /**
-     * This container but with a different command user
+     * Retrieves this containers with a different command user.
      */
     withUser(name: string): Container;
     /**
-     * This container but with a different working directory
+     * Retrieves this container with a different working directory.
      */
     withWorkdir(path: string): Container;
     /**
-     * This container minus the given environment variable
+     * Retrieves this container minus the given environment variable.
      */
     withoutEnvVariable(name: string): Container;
     /**
-     * This container after unmounting everything at the given path.
+     * Retrieves this container minus the given environment label.
+     */
+    withoutLabel(name: string): Container;
+    /**
+     * Retrieves this container after unmounting everything at the given path.
      */
     withoutMount(path: string): Container;
     /**
-     * This container with a previously added Unix socket removed
+     * Retrieves this container with a previously added Unix socket removed.
      */
     withoutUnixSocket(path: string): Container;
     /**
-     * The working directory for all commands
+     * Retrieves the working directory for all commands.
      */
     workdir(): Promise<string>;
 }
 /**
- * A directory
+ * A directory.
  */
 export declare class Directory extends BaseClient {
     /**
-     * The difference between this directory and an another directory
+     * Gets the difference between this directory and an another directory.
      */
-    diff(other: DirectoryID | Directory): Directory;
+    diff(other: Directory): Directory;
     /**
-     * Retrieve a directory at the given path
+     * Retrieves a directory at the given path.
      */
     directory(path: string): Directory;
     /**
-     * Build a new Docker container from this directory
+     * Builds a new Docker container from this directory.
+     * @param opts.dockerfile Path to the Dockerfile to use.
+  Defaults to './Dockerfile'.
+     * @param opts.platform The platform to build.
+     * @param opts.buildArgs Additional build arguments.
+     * @param opts.target Target build stage to build.
      */
     dockerBuild(opts?: DirectoryDockerBuildOpts): Container;
     /**
-     * Return a list of files and directories at the given path
+     * Returns a list of files and directories at the given path.
      */
     entries(opts?: DirectoryEntriesOpts): Promise<string[]>;
     /**
-     * Write the contents of the directory to a path on the host
+     * Writes the contents of the directory to a path on the host.
      */
     export(path: string): Promise<boolean>;
     /**
-     * Retrieve a file at the given path
+     * Retrieves a file at the given path.
      */
     file(path: string): File;
     /**
-     * The content-addressed identifier of the directory
+     * The content-addressed identifier of the directory.
      */
     id(): Promise<DirectoryID>;
     /**
@@ -397,138 +523,167 @@ export declare class Directory extends BaseClient {
      */
     loadProject(configPath: string): Project;
     /**
-     * This directory plus a directory written at the given path
+     * Creates a named sub-pipeline.
+     */
+    pipeline(name: string, opts?: DirectoryPipelineOpts): Directory;
+    /**
+     * Retrieves this directory plus a directory written at the given path.
+     * @param opts.exclude Exclude artifacts that match the given pattern.
+  (e.g. ["node_modules/", ".git*"]).
+     * @param opts.include Include only artifacts that match the given pattern.
+  (e.g. ["app/", "package.*"]).
+     */
+    withDirectory(path: string, directory: Directory, opts?: DirectoryWithDirectoryOpts): Directory;
+    /**
+     * Retrieves this directory plus the contents of the given file copied to the given path.
      */
-    withDirectory(path: string, directory: DirectoryID | Directory, opts?: DirectoryWithDirectoryOpts): Directory;
+    withFile(path: string, source: File, opts?: DirectoryWithFileOpts): Directory;
     /**
-     * This directory plus the contents of the given file copied to the given path
+     * Retrieves this directory plus a new directory created at the given path.
      */
-    withFile(path: string, source: FileID | File): Directory;
+    withNewDirectory(path: string, opts?: DirectoryWithNewDirectoryOpts): Directory;
     /**
-     * This directory plus a new directory created at the given path
+     * Retrieves this directory plus a new file written at the given path.
      */
-    withNewDirectory(path: string): Directory;
+    withNewFile(path: string, contents: string, opts?: DirectoryWithNewFileOpts): Directory;
     /**
-     * This directory plus a new file written at the given path
+     * Retrieves this directory with all file/dir timestamps set to the given time, in seconds from the Unix epoch.
      */
-    withNewFile(path: string, contents: string): Directory;
+    withTimestamps(timestamp: number): Directory;
     /**
-     * This directory with the directory at the given path removed
+     * Retrieves this directory with the directory at the given path removed.
      */
     withoutDirectory(path: string): Directory;
     /**
-     * This directory with the file at the given path removed
+     * Retrieves this directory with the file at the given path removed.
      */
     withoutFile(path: string): Directory;
 }
 /**
- * EnvVariable is a simple key value object that represents an environment variable.
+ * A simple key value object that represents an environment variable.
  */
 export declare class EnvVariable extends BaseClient {
     /**
-     * name is the environment variable name.
+     * The environment variable name.
      */
     name(): Promise<string>;
     /**
-     * value is the environment variable value
+     * The environment variable value.
      */
     value(): Promise<string>;
 }
 /**
- * A file
+ * A file.
  */
 export declare class File extends BaseClient {
     /**
-     * The contents of the file
+     * Retrieves the contents of the file.
      */
     contents(): Promise<string>;
     /**
-     * Write the file to a file path on the host
+     * Writes the file to a file path on the host.
      */
     export(path: string): Promise<boolean>;
     /**
-     * The content-addressed identifier of the file
+     * Retrieves the content-addressed identifier of the file.
      */
     id(): Promise<FileID>;
+    /**
+     * Retrieves a secret referencing the contents of this file.
+     */
     secret(): Secret;
     /**
-     * The size of the file, in bytes
+     * Gets the size of the file, in bytes.
      */
     size(): Promise<number>;
+    /**
+     * Retrieves this file with its created/modified timestamps set to the given time, in seconds from the Unix epoch.
+     */
+    withTimestamps(timestamp: number): File;
 }
 /**
- * A git ref (tag or branch)
+ * A git ref (tag, branch or commit).
  */
 export declare class GitRef extends BaseClient {
     /**
-     * The digest of the current value of this ref
+     * The digest of the current value of this ref.
      */
     digest(): Promise<string>;
     /**
-     * The filesystem tree at this ref
+     * The filesystem tree at this ref.
      */
     tree(opts?: GitRefTreeOpts): Directory;
 }
 /**
- * A git repository
+ * A git repository.
  */
 export declare class GitRepository extends BaseClient {
     /**
-     * Details on one branch
+     * Returns details on one branch.
      */
     branch(name: string): GitRef;
     /**
-     * List of branches on the repository
+     * Lists of branches on the repository.
      */
     branches(): Promise<string[]>;
     /**
-     * Details on one commit
+     * Returns details on one commit.
      */
     commit(id: string): GitRef;
     /**
-     * Details on one tag
+     * Returns details on one tag.
      */
     tag(name: string): GitRef;
     /**
-     * List of tags on the repository
+     * Lists of tags on the repository.
      */
     tags(): Promise<string[]>;
 }
 /**
- * Information about the host execution environment
+ * Information about the host execution environment.
  */
 export declare class Host extends BaseClient {
     /**
-     * Access a directory on the host
+     * Accesses a directory on the host.
      */
     directory(path: string, opts?: HostDirectoryOpts): Directory;
     /**
-     * Access an environment variable on the host
+     * Accesses an environment variable on the host.
      */
     envVariable(name: string): HostVariable;
     /**
-     * Access a Unix socket on the host
+     * Accesses a Unix socket on the host.
      */
     unixSocket(path: string): Socket;
     /**
-     * The current working directory on the host
-     *
-     * @param opts optional params for workdir
-     *
+     * Retrieves the current working directory on the host.
      * @deprecated Use directory with path set to '.' instead.
      */
     workdir(opts?: HostWorkdirOpts): Directory;
 }
 /**
- * An environment variable on the host environment
+ * An environment variable on the host environment.
  */
 export declare class HostVariable extends BaseClient {
     /**
-     * A secret referencing the value of this variable
+     * A secret referencing the value of this variable.
      */
     secret(): Secret;
     /**
-     * The value of this variable
+     * The value of this variable.
+     */
+    value(): Promise<string>;
+}
+/**
+ * A simple key value object that represents a label.
+ */
+export declare class Label extends BaseClient {
+    /**
+     * The label name.
+     */
+    name(): Promise<string>;
+    /**
+     * The label value.
      */
     value(): Promise<string>;
 }
@@ -563,11 +718,12 @@ export declare class Project extends BaseClient {
 }
 export default class Client extends BaseClient {
     /**
-     * Construct a cache volume for a given cache key
+     * Constructs a cache volume for a given cache key.
+     * @param key A string identifier to target this cache volume (e.g. "myapp-cache").
      */
     cacheVolume(key: string): CacheVolume;
     /**
-     * Load a container from ID.
+     * 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.
      */
@@ -581,50 +737,54 @@ export default class Client extends BaseClient {
      */
     directory(opts?: ClientDirectoryOpts): Directory;
     /**
-     * Load a file by ID
+     * Loads a file by ID.
      */
-    file(id: FileID | File): File;
+    file(id: FileID): File;
     /**
-     * Query a git repository
+     * Queries a git repository.
      */
     git(url: string, opts?: ClientGitOpts): GitRepository;
     /**
-     * Query the host environment
+     * Queries the host environment.
      */
     host(): Host;
     /**
-     * An http remote
+     * Returns a file containing an http remote url content.
      */
     http(url: string): File;
+    /**
+     * Creates a named sub-pipeline
+     */
+    pipeline(name: string, opts?: ClientPipelineOpts): Client;
     /**
      * Look up a project by name
      */
     project(name: string): Project;
     /**
-     * Load a secret from its ID
+     * Loads a secret from its ID.
      */
-    secret(id: SecretID | Secret): Secret;
+    secret(id: SecretID): Secret;
     /**
-     * Load a socket by ID
+     * Loads a socket by its ID.
      */
     socket(opts?: ClientSocketOpts): Socket;
 }
 /**
- * A reference to a secret value, which can be handled more safely than the value itself
+ * A reference to a secret value, which can be handled more safely than the value itself.
  */
 export declare class Secret extends BaseClient {
     /**
-     * The identifier for this secret
+     * The identifier for this secret.
      */
     id(): Promise<SecretID>;
     /**
-     * The value of this secret
+     * The value of this secret.
      */
     plaintext(): Promise<string>;
 }
 export declare class Socket extends BaseClient {
     /**
-     * The content-addressed identifier of the socket
+     * The content-addressed identifier of the socket.
      */
     id(): Promise<SocketID>;
 }