podman 0.1.5 → 0.2.0

package/dist/index.d.ts

@@ -1,732 +1,5 @@
-import type { Readable } from 'node:stream';
-type PodmanBuildOptions = {
-    /** Build context directory. */
-    context?: string;
-    /** Add a custom host-to-IP mapping (host:ip). */
-    addHost?: string | string[];
-    /** Attempt to build for all base image platforms. */
-    allPlatforms?: boolean;
-    /** Set metadata for an image. */
-    annotation?: string | string[];
-    /** Set the ARCH of the image to the provided value instead of the architecture of the host. */
-    arch?: string;
-    /** Path of the authentication file. */
-    authfile?: string;
-    /** Argument=value to supply to the builder. */
-    buildArg?: string | string[];
-    /** Argfile.conf containing lines of argument=value to supply to the builder. */
-    buildArgFile?: string;
-    /** Argument=value to supply additional build context to the builder. */
-    buildContext?: string | string[];
-    /** Remote repository list to utilise as potential cache source. */
-    cacheFrom?: string | string[];
-    /** Remote repository list to utilise as potential cache destination. */
-    cacheTo?: string | string[];
-    /** Only consider cache images under specified duration. */
-    cacheTtl?: string;
-    /** Add the specified capability when running. */
-    capAdd?: string | string[];
-    /** Drop the specified capability when running. */
-    capDrop?: string | string[];
-    /** Use certificates at the specified path to access the registry. */
-    certDir?: string;
-    /** Optional parent cgroup for the container. */
-    cgroupParent?: string;
-    /** 'private', or 'host'. */
-    cgroupns?: string;
-    /** Preserve the contents of VOLUMEs during RUN instructions. */
-    compatVolumes?: boolean;
-    /** Set additional flag to pass to C preprocessor (cpp). */
-    cppFlag?: string | string[];
-    /** Limit the CPU CFS (Completely Fair Scheduler) period. */
-    cpuPeriod?: number;
-    /** Limit the CPU CFS (Completely Fair Scheduler) quota. */
-    cpuQuota?: number;
-    /** CPU shares (relative weight). */
-    cpuShares?: number;
-    /** CPUs in which to allow execution (0-3, 0,1). */
-    cpusetCpus?: string;
-    /** Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. */
-    cpusetMems?: string;
-    /** Set an "org.opencontainers.image.created" annotation in the image. */
-    createdAnnotation?: boolean;
-    /** Use username[:password] for accessing the registry. */
-    creds?: string;
-    /** Key needed to decrypt the image. */
-    decryptionKey?: string | string[];
-    /** Additional devices to provide. */
-    device?: string | string[];
-    /** Do not compress layers by default. */
-    disableCompression?: boolean;
-    /** Set custom DNS servers or disable it completely by setting it to 'none'. */
-    dns?: string;
-    /** Set custom DNS options. */
-    dnsOption?: string | string[];
-    /** Set custom DNS search domains. */
-    dnsSearch?: string | string[];
-    /** Set environment variable for the image. */
-    env?: string | string[];
-    /** Pathname or URL of a Dockerfile. */
-    file?: string;
-    /** Always remove intermediate containers after a build, even if the build is unsuccessful. */
-    forceRm?: boolean;
-    /** Format of the built image's manifest and metadata. */
-    format?: string;
-    /** Image name used to replace the value in the first FROM instruction in the Containerfile. */
-    from?: string;
-    /** Add additional groups to the primary container process. */
-    groupAdd?: string | string[];
-    /** Set the OCI hooks directory path (may be set multiple times). */
-    hooksDir?: string | string[];
-    /** Pass through HTTP Proxy environment variables. */
-    httpProxy?: boolean;
-    /** Add default identity label. */
-    identityLabel?: boolean;
-    /** Path to an alternate .dockerignore file. */
-    ignorefile?: string;
-    /** File to write the image ID to. */
-    iidfile?: string;
-    /** Inherit the annotations from the base image or base stages. */
-    inheritAnnotations?: boolean;
-    /** Inherit the labels from the base image or base stages. */
-    inheritLabels?: boolean;
-    /** 'private', path of IPC namespace to join, or 'host'. */
-    ipc?: string;
-    /** Type of process isolation to use. */
-    isolation?: string;
-    /** How many stages to run in parallel. */
-    jobs?: number;
-    /** Set metadata for an image. */
-    label?: string | string[];
-    /** Set metadata for an intermediate image. */
-    layerLabel?: string | string[];
-    /** Use intermediate layers during build. */
-    layers?: boolean;
-    /** Log to file instead of stdout/stderr. */
-    logfile?: string;
-    /** Add the image to the specified manifest list. */
-    manifest?: string;
-    /** Memory limit (format: <number><unit>, where unit = b, k, m or g). */
-    memory?: string;
-    /** Swap limit equal to memory plus swap: '-1' to enable unlimited swap. */
-    memorySwap?: string;
-    /** 'private', 'none', 'ns:path' of network namespace to join, or 'host'. */
-    network?: string;
-    /** Do not use existing cached images for the container build. */
-    noCache?: boolean;
-    /** Do not create new /etc/hostname file for RUN instructions, use the one from the base image. */
-    noHostname?: boolean;
-    /** Do not create new /etc/hosts file for RUN instructions, use the one from the base image. */
-    noHosts?: boolean;
-    /** Omit build history information from built image. */
-    omitHistory?: boolean;
-    /** Set the OS to the provided value instead of the current operating system of the host. */
-    os?: string;
-    /** Set required OS feature for the target image in addition to values from the base image. */
-    osFeature?: string;
-    /** Set required OS version for the target image instead of the value from the base image. */
-    osVersion?: string;
-    /** Private, path of PID namespace to join, or 'host'. */
-    pid?: string;
-    /** Set the OS/ARCH[/VARIANT] of the image to the provided value instead of the current OS/ARCH. */
-    platform?: string;
-    /** Pull image policy ("always"|"missing"|"never"|"newer"). */
-    pull?: string;
-    /** Refrain from announcing build instructions and image read/write progress. */
-    quiet?: boolean;
-    /** Number of times to retry in case of failure when performing push/pull. */
-    retry?: number;
-    /** Delay between retries in case of push/pull failures. */
-    retryDelay?: string;
-    /** Set timestamps in layers to no later than the value for --source-date-epoch. */
-    rewriteTimestamp?: boolean;
-    /** Remove intermediate containers after a successful build. */
-    rm?: boolean;
-    /** Add global flags for the container runtime. */
-    runtimeFlag?: string | string[];
-    /** Scan working container using preset configuration. */
-    sbom?: string;
-    /** Add scan results to image as path. */
-    sbomImageOutput?: string;
-    /** Add scan results to image as path. */
-    sbomImagePurlOutput?: string;
-    /** Merge scan results using strategy. */
-    sbomMergeStrategy?: string;
-    /** Save scan results to file. */
-    sbomOutput?: string;
-    /** Save scan results to file. */
-    sbomPurlOutput?: string;
-    /** Scan working container using command in scanner image. */
-    sbomScannerCommand?: string;
-    /** Scan working container using scanner command from image. */
-    sbomScannerImage?: string;
-    /** Secret file to expose to the build. */
-    secret?: string | string[];
-    /** Security options. */
-    securityOpt?: string | string[];
-    /** Size of '/dev/shm'. The format is <number><unit>. */
-    shmSize?: string;
-    /** Skips stages in multi-stage builds which do not affect the final target. */
-    skipUnusedStages?: boolean;
-    /** Set new timestamps in image info to seconds after the epoch. */
-    sourceDateEpoch?: number;
-    /** Squash all image layers into a single layer. */
-    squash?: boolean;
-    /** Squash all layers into a single layer. */
-    squashAll?: boolean;
-    /** SSH agent socket or keys to expose to the build. */
-    ssh?: string | string[];
-    /** Pass stdin into containers. */
-    stdin?: boolean;
-    /** Tagged name to apply to the built image. */
-    tag?: string | string[];
-    /** Set the target build stage to build. */
-    target?: string;
-    /** Set new timestamps in image info and layer to seconds after the epoch. */
-    timestamp?: number;
-    /** Ulimit options. */
-    ulimit?: string | string[];
-    /** Unset annotation when inheriting annotations from base image. */
-    unsetannotation?: string | string[];
-    /** Unset environment variable from final image. */
-    unsetenv?: string | string[];
-    /** Unset label when inheriting labels from base image. */
-    unsetlabel?: string | string[];
-    /** 'container', path of user namespace to join, or 'host'. */
-    userns?: string;
-    /** ContainerGID:hostGID:length GID mapping to use in user namespace. */
-    usernsGidMap?: string;
-    /** Name of entries from /etc/subgid to use to set user namespace GID mapping. */
-    usernsGidMapGroup?: string;
-    /** ContainerUID:hostUID:length UID mapping to use in user namespace. */
-    usernsUidMap?: string;
-    /** Name of entries from /etc/subuid to use to set user namespace UID mapping. */
-    usernsUidMapUser?: string;
-    /** Private, :path of UTS namespace to join, or 'host'. */
-    uts?: string;
-    /** Override the variant of the specified image. */
-    variant?: string;
-    /** Bind mount a volume into the container. */
-    volume?: string | string[];
-};
-type PodmanPushOptions = {
-    /** Source image to push. */
-    image: string;
-    /** Destination to push the image to. */
-    destination?: string;
-    /** Path of the authentication file. */
-    authfile?: string;
-    /** Compression format to use. */
-    compressionFormat?: string;
-    /** Compression level to use. */
-    compressionLevel?: number;
-    /** Credentials (USERNAME:PASSWORD) to use for authenticating to a registry. */
-    creds?: string;
-    /** Write the digest of the pushed image to the specified file. */
-    digestfile?: string;
-    /** This is a Docker specific option and is a NOOP. */
-    disableContentTrust?: boolean;
-    /** Use the specified compression algorithm even if the destination contains a differently-compressed variant already. */
-    forceCompression?: boolean;
-    /** Manifest type (oci, v2s2, or v2s1) to use in the destination. */
-    format?: string;
-    /** Discard any pre-existing signatures in the image. */
-    removeSignatures?: boolean;
-    /** Number of times to retry in case of failure when performing push. */
-    retry?: number;
-    /** Delay between retries in case of push failures. */
-    retryDelay?: string;
-    /** Require HTTPS and verify certificates when contacting registries. */
-    tlsVerify?: boolean;
-};
-type PodmanRunOptions = {
-    /** Image to run. */
-    image: string;
-    /** Command to run in the container. */
-    command?: string | string[];
-    /** Additional arguments to pass to the command. */
-    commandArgs?: string[];
-    /** Add a custom host-to-IP mapping (host:ip). */
-    addHost?: string | string[];
-    /** Add annotations to container (key=value). */
-    annotation?: string | string[];
-    /** Use ARCH instead of the architecture of the machine for choosing images. */
-    arch?: string;
-    /** Attach to STDIN, STDOUT or STDERR. */
-    attach?: string | string[];
-    /** Path of the authentication file. */
-    authfile?: string;
-    /** Block IO weight (relative weight) accepts a weight value between 10 and 1000. */
-    blkioWeight?: string;
-    /** Block IO weight (relative device weight, format: DEVICE_NAME:WEIGHT). */
-    blkioWeightDevice?: string | string[];
-    /** Add capabilities to the container. */
-    capAdd?: string | string[];
-    /** Drop capabilities from the container. */
-    capDrop?: string | string[];
-    /** Configure cgroup v2 (key=value). */
-    cgroupConf?: string | string[];
-    /** Optional parent cgroup for the container. */
-    cgroupParent?: string;
-    /** Cgroup namespace to use. */
-    cgroupns?: string;
-    /** Control container cgroup configuration ("enabled"|"disabled"|"no-conmon"|"split"). */
-    cgroups?: string;
-    /** Chroot directories inside the container. */
-    chrootdirs?: string | string[];
-    /** Write the container ID to the file. */
-    cidfile?: string;
-    /** Limit the CPU CFS (Completely Fair Scheduler) period. */
-    cpuPeriod?: number;
-    /** Limit the CPU CFS (Completely Fair Scheduler) quota. */
-    cpuQuota?: number;
-    /** Limit the CPU real-time period in microseconds. */
-    cpuRtPeriod?: number;
-    /** Limit the CPU real-time runtime in microseconds. */
-    cpuRtRuntime?: number;
-    /** CPU shares (relative weight). */
-    cpuShares?: number;
-    /** Number of CPUs. The default is 0.000 which means no limit. */
-    cpus?: number;
-    /** CPUs in which to allow execution (0-3, 0,1). */
-    cpusetCpus?: string;
-    /** Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. */
-    cpusetMems?: string;
-    /** Run container in background and print container ID. */
-    detach?: boolean;
-    /** Override the key sequence for detaching a container. */
-    detachKeys?: string;
-    /** Add a host device to the container. */
-    device?: string | string[];
-    /** Add a rule to the cgroup allowed devices list. */
-    deviceCgroupRule?: string | string[];
-    /** Limit read rate (bytes per second) from a device. */
-    deviceReadBps?: string | string[];
-    /** Limit read rate (IO per second) from a device. */
-    deviceReadIops?: string | string[];
-    /** Limit write rate (bytes per second) to a device. */
-    deviceWriteBps?: string | string[];
-    /** Limit write rate (IO per second) to a device. */
-    deviceWriteIops?: string | string[];
-    /** This is a Docker specific option and is a NOOP. */
-    disableContentTrust?: boolean;
-    /** Set custom DNS servers. */
-    dns?: string | string[];
-    /** Set custom DNS options. */
-    dnsOption?: string | string[];
-    /** Set custom DNS search domains. */
-    dnsSearch?: string | string[];
-    /** Overwrite the default ENTRYPOINT of the image. */
-    entrypoint?: string;
-    /** Set environment variables in container. */
-    env?: string | string[];
-    /** Read in a file of environment variables. */
-    envFile?: string | string[];
-    /** Preprocess environment variables from image before injecting them into the container. */
-    envMerge?: string | string[];
-    /** Expose a port or a range of ports. */
-    expose?: string | string[];
-    /** GID map to use for the user namespace. */
-    gidmap?: string | string[];
-    /** GPU devices to add to the container ('all' to pass all GPUs). */
-    gpus?: string | string[];
-    /** Add additional groups to the primary container process. */
-    groupAdd?: string | string[];
-    /** Entry to write to /etc/group. */
-    groupEntry?: string;
-    /** Set a healthcheck command for the container ('none' disables the existing healthcheck). */
-    healthCmd?: string;
-    /** Set an interval for the healthcheck. */
-    healthInterval?: string;
-    /** Set the destination of the HealthCheck log. */
-    healthLogDestination?: string;
-    /** Set maximum number of attempts in the HealthCheck log file. */
-    healthMaxLogCount?: number;
-    /** Set maximum length in characters of stored HealthCheck log. */
-    healthMaxLogSize?: number;
-    /** Action to take once the container turns unhealthy. */
-    healthOnFailure?: string;
-    /** The number of retries allowed before a healthcheck is considered to be unhealthy. */
-    healthRetries?: number;
-    /** The initialization time needed for a container to bootstrap. */
-    healthStartPeriod?: string;
-    /** Set a startup healthcheck command for the container. */
-    healthStartupCmd?: string;
-    /** Set an interval for the startup healthcheck. */
-    healthStartupInterval?: string;
-    /** Set the maximum number of retries before the startup healthcheck will restart the container. */
-    healthStartupRetries?: number;
-    /** Set the number of consecutive successes before the startup healthcheck is marked as successful. */
-    healthStartupSuccess?: number;
-    /** Set the maximum amount of time that the startup healthcheck may take before it is considered failed. */
-    healthStartupTimeout?: string;
-    /** The maximum time allowed to complete the healthcheck before an interval is considered failed. */
-    healthTimeout?: string;
-    /** Set container hostname. */
-    hostname?: string;
-    /** Base file to create the /etc/hosts file inside the container, or one of the special values. */
-    hostsFile?: string;
-    /** Host user account to add to /etc/passwd within container. */
-    hostuser?: string | string[];
-    /** Set proxy environment variables in the container based on the host proxy vars. */
-    httpProxy?: boolean;
-    /** Tells podman how to handle the builtin image volumes ("bind"|"tmpfs"|"ignore"). */
-    imageVolume?: string;
-    /** Run an init binary inside the container that forwards signals and reaps processes. */
-    init?: boolean;
-    /** Path to the container-init binary. */
-    initPath?: string;
-    /** Make STDIN available to the contained process. */
-    interactive?: boolean;
-    /** Specify a static IPv4 address for the container. */
-    ip?: string;
-    /** Specify a static IPv6 address for the container. */
-    ip6?: string;
-    /** IPC namespace to use. */
-    ipc?: string;
-    /** Set metadata on container. */
-    label?: string | string[];
-    /** Read in a line delimited file of labels. */
-    labelFile?: string | string[];
-    /** Logging driver for the container. */
-    logDriver?: string;
-    /** Logging driver options. */
-    logOpt?: string | string[];
-    /** Container MAC address. */
-    macAddress?: string;
-    /** Memory limit (format: <number><unit>). */
-    memory?: string;
-    /** Memory soft limit (format: <number><unit>). */
-    memoryReservation?: string;
-    /** Swap limit equal to memory plus swap: '-1' to enable unlimited swap. */
-    memorySwap?: string;
-    /** Tune container memory swappiness (0 to 100, or -1 for system default). */
-    memorySwappiness?: number;
-    /** Attach a filesystem mount to the container. */
-    mount?: string | string[];
-    /** Assign a name to the container. */
-    name?: string;
-    /** Connect a container to a network. */
-    network?: string | string[];
-    /** Add network-scoped alias for the container. */
-    networkAlias?: string | string[];
-    /** Disable healthchecks on container. */
-    noHealthcheck?: boolean;
-    /** Do not create /etc/hostname within the container, instead use the version from the image. */
-    noHostname?: boolean;
-    /** Do not create /etc/hosts within the container, instead use the version from the image. */
-    noHosts?: boolean;
-    /** Disable OOM Killer. */
-    oomKillDisable?: boolean;
-    /** Tune the host's OOM preferences (-1000 to 1000). */
-    oomScoreAdj?: number;
-    /** Use OS instead of the running OS for choosing images. */
-    os?: string;
-    /** Add entries to /etc/passwd and /etc/group. */
-    passwd?: boolean;
-    /** Entry to write to /etc/passwd. */
-    passwdEntry?: string;
-    /** Configure execution domain using personality (e.g., LINUX/LINUX32). */
-    personality?: string;
-    /** PID namespace to use. */
-    pid?: string;
-    /** Tune container pids limit (set -1 for unlimited). */
-    pidsLimit?: number;
-    /** Specify the platform for selecting the image. */
-    platform?: string;
-    /** Run container in an existing pod. */
-    pod?: string;
-    /** Read the pod ID from the file. */
-    podIdFile?: string;
-    /** Give extended privileges to container. */
-    privileged?: boolean;
-    /** Publish a container's port, or a range of ports, to the host. */
-    publish?: string | string[];
-    /** Publish all exposed ports to random ports on the host interface. */
-    publishAll?: boolean;
-    /** Pull image policy ("always"|"missing"|"never"|"newer"). */
-    pull?: string;
-    /** Suppress output information when pulling images. */
-    quiet?: boolean;
-    /** Class of Service (COS) that the container should be assigned to. */
-    rdtClass?: string;
-    /** Make containers root filesystem read-only. */
-    readOnly?: boolean;
-    /** When running --read-only containers mount read-write tmpfs on /dev, /dev/shm, /run, /tmp and /var/tmp. */
-    readOnlyTmpfs?: boolean;
-    /** If a container with the same name exists, replace it. */
-    replace?: boolean;
-    /** Add one or more requirement containers that must be started before this container will start. */
-    requires?: string | string[];
-    /** Restart policy to apply when a container exits. */
-    restart?: string;
-    /** Number of times to retry in case of failure when performing pull. */
-    retry?: number;
-    /** Delay between retries in case of pull failures. */
-    retryDelay?: string;
-    /** Remove container and any anonymous unnamed volume associated with the container after exit. */
-    rm?: boolean;
-    /** Remove image unless used by other containers, implies --rm. */
-    rmi?: boolean;
-    /** The first argument is not an image but the rootfs to the exploded container. */
-    rootfs?: boolean;
-    /** Control sd-notify behavior ("container"|"conmon"|"healthy"|"ignore"). */
-    sdnotify?: string;
-    /** Policy for selecting a seccomp profile (experimental). */
-    seccompPolicy?: string;
-    /** Add secret to container. */
-    secret?: string | string[];
-    /** Security Options. */
-    securityOpt?: string | string[];
-    /** Size of /dev/shm (format: <number><unit>). */
-    shmSize?: string;
-    /** Size of systemd specific tmpfs mounts (/run, /run/lock). */
-    shmSizeSystemd?: string;
-    /** Proxy received signals to the process. */
-    sigProxy?: boolean;
-    /** Signal to stop a container. Default is SIGTERM. */
-    stopSignal?: string;
-    /** Timeout (in seconds) that containers stopped by user command have to exit. */
-    stopTimeout?: number;
-    /** Name of range listed in /etc/subgid for use in user namespace. */
-    subgidname?: string;
-    /** Name of range listed in /etc/subuid for use in user namespace. */
-    subuidname?: string;
-    /** Sysctl options. */
-    sysctl?: string | string[];
-    /** Run container in systemd mode ("true"|"false"|"always"). */
-    systemd?: string;
-    /** Maximum length of time a container is allowed to run. */
-    timeout?: number;
-    /** Require HTTPS and verify certificates when contacting registries for pulling images. */
-    tlsVerify?: boolean;
-    /** Mount a temporary filesystem (tmpfs) into a container. */
-    tmpfs?: string;
-    /** Allocate a pseudo-TTY for container. */
-    tty?: boolean;
-    /** Set timezone in container. */
-    tz?: string;
-    /** UID map to use for the user namespace. */
-    uidmap?: string | string[];
-    /** Ulimit options. */
-    ulimit?: string | string[];
-    /** Set umask in container. */
-    umask?: string;
-    /** Unset environment default variables in container. */
-    unsetenv?: string | string[];
-    /** Unset all default environment variables in container. */
-    unsetenvAll?: boolean;
-    /** Username or UID (format: <name|uid>[:<group|gid>]). */
-    user?: string;
-    /** User namespace to use. */
-    userns?: string;
-    /** UTS namespace to use. */
-    uts?: string;
-    /** Use VARIANT instead of the running architecture variant for choosing images. */
-    variant?: string;
-    /** Bind mount a volume into the container. */
-    volume?: string | string[];
-    /** Mount volumes from the specified container(s). */
-    volumesFrom?: string | string[];
-    /** Working directory inside the container. */
-    workdir?: string;
-};
-/**
- * Output handling strategy for spawned processes.
- *
- * @example
- * ```ts
- * import {ProcessOutput} from 'podman'
- *
- * const mode = ProcessOutput.Tee
- * ```
- */
-export declare enum ProcessOutput {
-    /** Capture output in a stream. */
-    Pipe = "pipe",
-    /** Discard output. */
-    Ignore = "ignore",
-    /** Forward output to the parent process. */
-    Inherit = "inherit",
-    /** Capture output and also forward it to the parent process. */
-    Tee = "tee"
-}
-/**
- * Process output configuration for podman run.
- *
- * @example
- * ```ts
- * import {ProcessOutput} from 'podman'
- *
- * const options = {stdout: ProcessOutput.Tee, stderr: ProcessOutput.Pipe}
- * ```
- */
-export type ProcessOptions = {
-    /** How stdout is handled. Defaults to [`ProcessOutput.Inherit`]{@link ProcessOutput.Inherit}. */
-    stdout?: ProcessOutput;
-    /** How stderr is handled. Defaults to [`ProcessOutput.Inherit`]{@link ProcessOutput.Inherit}. */
-    stderr?: ProcessOutput;
-};
-/**
- * Handle returned by [`run`]{@link run} to control the podman process.
- *
- * @example
- * ```ts
- * import {run, ProcessOutput} from 'podman'
- *
- * const proc = run(
- *     {image: 'alpine:latest', command: 'echo', commandArgs: ['hello']},
- *     {stdout: ProcessOutput.Tee},
- * )
- * await proc.waitThrow()
- * ```
- */
-export type PodmanRunHandle = {
-    /**
-     * Sends SIGKILL to the podman process.
-     *
-     * @returns True if the signal was sent, false otherwise.
-     *
-     * @example
-     * ```ts
-     * import {run} from 'podman'
-     *
-     * const proc = await run({image: 'alpine:latest', command: 'sleep', commandArgs: ['60']})
-     * proc.kill()
-     * ```
-     */
-    kill: () => boolean;
-    /**
-     * Sends SIGTERM to the podman process.
-     *
-     * @returns True if the signal was sent, false otherwise.
-     *
-     * @example
-     * ```ts
-     * import {run} from 'podman'
-     *
-     * const proc = await run({image: 'alpine:latest', command: 'sleep', commandArgs: ['60']})
-     * proc.term()
-     * ```
-     */
-    term: () => boolean;
-    /**
-     * Waits for the podman process to exit.
-     *
-     * @returns Resolves with the exit code of the podman process.
-     *
-     * @example
-     * ```ts
-     * import {run} from 'podman'
-     *
-     * const proc = await run({image: 'alpine:latest', command: 'true'})
-     * const code = await proc.wait()
-     * console.log(code)
-     * ```
-     */
-    wait: () => Promise<number>;
-    /**
-     * Waits for the podman process to exit and rejects on non-zero exit codes.
-     *
-     * @returns Resolves with the exit code when it is zero.
-     *
-     * @example
-     * ```ts
-     * import {run} from 'podman'
-     *
-     * const proc = await run({image: 'alpine:latest', command: 'false'})
-     * await proc.waitThrow()
-     * ```
-     */
-    waitThrow: () => Promise<number>;
-    /** Stdout stream when configured with [`ProcessOutput.Pipe`]{@link ProcessOutput.Pipe} or [`ProcessOutput.Tee`]{@link ProcessOutput.Tee}. */
-    stdout: Readable | null;
-    /** Stderr stream when configured with [`ProcessOutput.Pipe`]{@link ProcessOutput.Pipe} or [`ProcessOutput.Tee`]{@link ProcessOutput.Tee}. */
-    stderr: Readable | null;
-};
-/**
- * Ensures the Podman machine is running.
- *
- * @param machineName Name of the Podman machine to start.
- * @returns Resolves to true when a machine start was triggered, or false if it is already running.
- *
- * @example
- * ```ts
- * import {startMachine} from 'podman'
- *
- * const started = await startMachine()
- * if (started) {
- *     console.log('Podman machine booted.')
- * }
- * ```
- */
-export declare function startMachine(machineName?: string): Promise<boolean>;
-/**
- * Builds a container image using podman build.
- *
- * Use [`startMachine`]{@link startMachine} first when running against a Podman VM.
- *
- * @param options Build options for podman build.
- * @returns Resolves with the built image ID (sha256 hash).
- *
- * @example
- * ```ts
- * import {build} from 'podman'
- *
- * const imageId = await build({context: '.', tag: 'my-app:latest'})
- * console.log(imageId)
- * ```
- *
- * @example
- * ```ts
- * import {startMachine, build} from 'podman'
- *
- * await startMachine()
- * const imageId = await build({file: './Containerfile', tag: 'my-app:dev'})
- * console.log(imageId)
- * ```
- */
-export declare function build(options?: PodmanBuildOptions): Promise<string>;
-/**
- * Pushes a container image to a specified destination.
- *
- * @param options Push options for podman push.
- * @returns Resolves when the push succeeds.
- *
- * @example
- * ```ts
- * import {push} from 'podman'
- *
- * await push({image: 'my-app:latest', destination: 'docker://registry.example.com/my-app:latest'})
- * ```
- */
-export declare function push(options: PodmanPushOptions): Promise<void>;
-/**
- * Runs a command in a new container.
- *
- * @param options Run options for podman run.
- * @param processOptions Output handling for the spawned podman process.
- * @returns Handle for controlling the running podman process.
- *
- * @example
- * ```ts
- * import {run} from 'podman'
- *
- * const proc = run({image: 'alpine:latest', command: 'echo', commandArgs: ['hello from podman']})
- * await proc.waitThrow()
- * ```
- *
- * @example
- * ```ts
- * import {run, ProcessOutput} from 'podman'
- *
- * const proc = run(
- *     {image: 'alpine:latest', command: 'sh', commandArgs: ['-c', 'echo hello; echo err 1>&2']},
- *     {stdout: ProcessOutput.Tee, stderr: ProcessOutput.Pipe},
- * )
- * const code = await proc.wait()
- * console.log(code, proc.stderr)
- * ```
- */
-export declare function run(options: PodmanRunOptions, processOptions?: ProcessOptions): PodmanRunHandle;
-export {};
+export { run } from './commands/run';
+export { build } from './commands/build';
+export { push } from './commands/push';
+export { tag } from './commands/tag';
+export { forceStartMachine, isMachineRunning, listMachines, startMachine } from './commands/start-machine.ts';