1. class
  2. Dagger
  3. \
  4. Workspace

Workspace

class Workspace extends AbstractObject implements IdAble, Node

A Dagger workspace detected from the current working directory or constructed from a Directory.

Properties

$lastQuery from  AbstractObject

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

from  AbstractObject
null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

from  AbstractObject
string
address()

Canonical Dagger address of the workspace location, or an opaque identity for synthetic workspaces.

Changeset
changes()

Return this workspace's pending overlay changes.

CheckGroup
checks(array|null $include = null, array|null $skip = null, bool|null $noGenerate = null, bool|null $onlyGenerate = null)

Return all checks from modules loaded in the workspace.

string
configFile()

Selected native workspace config file relative to the workspace root, if any.

string
configRead(string|null $key = '')

Read a configuration value from dagger.toml.

string
cwd()

Current location within the workspace root.

Directory
directory(string $path, array|null $exclude = [], array|null $include = [], bool|null $gitignore = false)

Returns a Directory from the workspace.

array
envList()

List named environments defined in the workspace configuration.

void
export()

Write this workspace's pending changes to its local Git workspace.

File
file(string $path)

Returns a File from the workspace.

string
findUp(string $name, string|null $from = '.')

Search for a file or directory by walking up from the start path within the workspace.

GeneratorGroup
generators(array|null $include = null)

Return all generators from modules loaded in the workspace.

WorkspaceGit
git()

Git state for this workspace. Errors if the workspace is not in a git repository.

array
glob(string $pattern)

Returns a list of files and directories that match the given pattern.

Id
id()

A unique identifier for this Workspace.

WorkspaceMigration
migrate()

Plan the explicit migration needed for the current workspace.

WorkspaceModule
module(string $name)

Return a module defined in the workspace configuration.

ModuleSource
moduleSource(string $path)

Load a module source from a path within the workspace.

array
modules()

List modules defined in the workspace configuration.

WorkspaceSDK
sdk(string $name)

An installed SDK, by name.

array
sdks()

Installed SDKs.

array
search(string $pattern, array|null $paths = [], array|null $globs = [], bool|null $literal = false, bool|null $multiline = false, bool|null $dotall = false, bool|null $insensitive = false, bool|null $skipIgnored = false, bool|null $skipHidden = false, bool|null $filesOnly = false, int|null $limit = null)

Searches for content matching the given regular expression or literal string.

UpGroup
services(array|null $include = null)

Return all services from modules loaded in the workspace.

Workspace
withChanges(Changeset $changes)

Return this workspace with a changeset applied, without mutating the source.

Workspace
withConfigEnv(string $name, bool|null $here = false)

Return this workspace with a named config environment created.

Workspace
withConfigValue(string $key, string $value, array|null $values = null, bool|null $here = false)

Return this workspace with a configuration value written.

Workspace
withInitClient(string $path, string $sdk, string $module, Json|null $args = null, bool|null $here = false)

Return this workspace with a generated API client initialized.

Workspace
withInitModule(string $name, string $sdk, string|null $path = '', string|null $source = '', array|null $include = [], Json|null $args = null, bool|null $here = false)

Return this workspace with a new module initialized.

Workspace
withModule(string $ref, string|null $name = '', bool|null $here = false)

Return this workspace with a module installed in its config.

Workspace
withNewDirectory(string $path, Directory $source)

Return this workspace with a directory added, without mutating the source.

Workspace
withNewFile(string $path, string $contents, int|null $permissions = 420)

Return this workspace with a new or replaced file, without mutating the source.

Workspace
withSDK(string $ref, string|null $name = '', bool|null $here = false, string|null $asSdkName = '')

Return this workspace with an SDK installed in its config.

Workspace
withUpdatedLock()

Return this workspace with refreshed lockfile state.

Workspace
withoutConfigEnv(string $name, bool|null $here = false)

Return this workspace with a named config environment removed.

Workspace
withoutConfigValue(string $key, bool|null $here = false)

Return this workspace with a configuration value removed.

Workspace
withoutModule(string $name, bool|null $here = false)

Return this workspace with a module removed from its config.

Workspace
withoutSDK(string $name, bool|null $here = false)

Return this workspace with an SDK removed from its config.

Details

in AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

Parameters

AbstractClient $client
QueryBuilderChain $queryBuilderChain

in AbstractObject at line 19
protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

Parameters

QueryBuilder $leafQueryBuilder
string $leafKey

Return Value

null|array|string|int|float|bool

at line 19
string address()

Canonical Dagger address of the workspace location, or an opaque identity for synthetic workspaces.

Return Value

string

at line 28
Changeset changes()

Return this workspace's pending overlay changes.

Return Value

Changeset

at line 37
CheckGroup checks(array|null $include = null, array|null $skip = null, bool|null $noGenerate = null, bool|null $onlyGenerate = null)

Return all checks from modules loaded in the workspace.

Parameters

array|null $include
array|null $skip
bool|null $noGenerate
bool|null $onlyGenerate

Return Value

CheckGroup

at line 62
string configFile()

Selected native workspace config file relative to the workspace root, if any.

Return Value

string

at line 77
string configRead(string|null $key = '')

Read a configuration value from dagger.toml.

If key is empty, returns the full config.

If key points to a scalar, returns the value.

If key points to a table, returns flattened dotted-key output.

Parameters

string|null $key

Return Value

string

at line 93
string cwd()

Current location within the workspace root.

The workspace root is returned as "/".

Relative paths in workspace APIs resolve from here.

Return Value

string

at line 104
Directory directory(string $path, array|null $exclude = [], array|null $include = [], bool|null $gitignore = false)

Returns a Directory from the workspace.

Relative paths resolve from the workspace cwd. Absolute paths resolve from the workspace root.

Parameters

string $path
array|null $exclude
array|null $include
bool|null $gitignore

Return Value

Directory

at line 127
array envList()

List named environments defined in the workspace configuration.

Return Value

array

at line 136
void export()

Write this workspace's pending changes to its local Git workspace.

Return Value

void

at line 147
File file(string $path)

Returns a File from the workspace.

Relative paths resolve from the workspace cwd. Absolute paths resolve from the workspace root.

Parameters

string $path

Return Value

File

at line 163
string findUp(string $name, string|null $from = '.')

Search for a file or directory by walking up from the start path within the workspace.

Returns the absolute workspace path if found, or null if not found.

Relative start paths resolve from the workspace cwd.

The search stops at the workspace root and will not traverse above it.

Parameters

string $name
string|null $from

Return Value

string

at line 176
GeneratorGroup generators(array|null $include = null)

Return all generators from modules loaded in the workspace.

Parameters

array|null $include

Return Value

GeneratorGroup

at line 188
WorkspaceGit git()

Git state for this workspace. Errors if the workspace is not in a git repository.

Return Value

WorkspaceGit

at line 199
array glob(string $pattern)

Returns a list of files and directories that match the given pattern.

Patterns match paths relative to the workspace root.

Parameters

string $pattern

Return Value

array

at line 209
Id id()

A unique identifier for this Workspace.

Return Value

Id

at line 220
WorkspaceMigration migrate()

Plan the explicit migration needed for the current workspace.

The returned plan has an empty changeset and no steps when no migration is needed.

Return Value

WorkspaceMigration

at line 229
WorkspaceModule module(string $name)

Return a module defined in the workspace configuration.

Parameters

string $name

Return Value

WorkspaceModule

at line 243
ModuleSource moduleSource(string $path)

Load a module source from a path within the workspace.

Relative paths (e.g., "foo") resolve from the workspace cwd; absolute paths (e.g., "/foo") resolve from the workspace root.

Fails if the path does not point to an initialized module.

Parameters

string $path

Return Value

ModuleSource

at line 253
array modules()

List modules defined in the workspace configuration.

Return Value

array

at line 262
WorkspaceSDK sdk(string $name)

An installed SDK, by name.

Parameters

string $name

Return Value

WorkspaceSDK

at line 272
array sdks()

Installed SDKs.

Return Value

array

Searches for content matching the given regular expression or literal string.

Uses Rust regex syntax; escape literal ., [, ], {, }, | with backslashes.

Runs ripgrep on the client host, falling back to grep if unavailable.

Parameters

string $pattern
array|null $paths
array|null $globs
bool|null $literal
bool|null $multiline
bool|null $dotall
bool|null $insensitive
bool|null $skipIgnored
bool|null $skipHidden
bool|null $filesOnly
int|null $limit

Return Value

array

at line 336
UpGroup services(array|null $include = null)

Return all services from modules loaded in the workspace.

Parameters

array|null $include

Return Value

UpGroup

at line 348
Workspace withChanges(Changeset $changes)

Return this workspace with a changeset applied, without mutating the source.

Parameters

Changeset $changes

Return Value

Workspace

at line 358
Workspace withConfigEnv(string $name, bool|null $here = false)

Return this workspace with a named config environment created.

Parameters

string $name
bool|null $here

Return Value

Workspace

at line 371
Workspace withConfigValue(string $key, string $value, array|null $values = null, bool|null $here = false)

Return this workspace with a configuration value written.

Parameters

string $key
string $value
array|null $values
bool|null $here

Return Value

Workspace

at line 388
Workspace withInitClient(string $path, string $sdk, string $module, Json|null $args = null, bool|null $here = false)

Return this workspace with a generated API client initialized.

Parameters

string $path
string $sdk
string $module
Json|null $args
bool|null $here

Return Value

Workspace

at line 411
Workspace withInitModule(string $name, string $sdk, string|null $path = '', string|null $source = '', array|null $include = [], Json|null $args = null, bool|null $here = false)

Return this workspace with a new module initialized.

Parameters

string $name
string $sdk
string|null $path
string|null $source
array|null $include
Json|null $args
bool|null $here

Return Value

Workspace

at line 444
Workspace withModule(string $ref, string|null $name = '', bool|null $here = false)

Return this workspace with a module installed in its config.

Parameters

string $ref
string|null $name
bool|null $here

Return Value

Workspace

at line 460
Workspace withNewDirectory(string $path, Directory $source)

Return this workspace with a directory added, without mutating the source.

Parameters

string $path
Directory $source

Return Value

Workspace

at line 471
Workspace withNewFile(string $path, string $contents, int|null $permissions = 420)

Return this workspace with a new or replaced file, without mutating the source.

Parameters

string $path
string $contents
int|null $permissions

Return Value

Workspace

at line 485
Workspace withSDK(string $ref, string|null $name = '', bool|null $here = false, string|null $asSdkName = '')

Return this workspace with an SDK installed in its config.

Parameters

string $ref
string|null $name
bool|null $here
string|null $asSdkName

Return Value

Workspace

at line 504
Workspace withUpdatedLock()

Return this workspace with refreshed lockfile state.

Return Value

Workspace

at line 513
Workspace withoutConfigEnv(string $name, bool|null $here = false)

Return this workspace with a named config environment removed.

Parameters

string $name
bool|null $here

Return Value

Workspace

at line 528
Workspace withoutConfigValue(string $key, bool|null $here = false)

Return this workspace with a configuration value removed.

Errors when the key is not currently set.

Parameters

string $key
bool|null $here

Return Value

Workspace

at line 541
Workspace withoutModule(string $name, bool|null $here = false)

Return this workspace with a module removed from its config.

Parameters

string $name
bool|null $here

Return Value

Workspace

at line 554
Workspace withoutSDK(string $name, bool|null $here = false)

Return this workspace with an SDK removed from its config.

Parameters

string $name
bool|null $here

Return Value

Workspace