Workspace
class Workspace extends AbstractObject implements IdAble, Node
A Dagger workspace detected from the current working directory.
Properties
| $lastQuery | from AbstractObject |
Methods
No description
Canonical Dagger address of the workspace directory.
Return all checks from modules loaded in the workspace.
The client ID that owns this workspace's host filesystem.
Path to config.toml relative to the workspace boundary (empty if not initialized).
Returns a Directory from the workspace.
Search for a file or directory by walking up from the start path within the workspace.
Return all generators from modules loaded in the workspace.
Whether a config.toml file exists in the workspace.
Whether .dagger/config.toml exists.
Workspace directory path relative to the workspace boundary.
Return all services from modules loaded in the workspace.
Details
in
AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)
No description
in
AbstractObject at line 19
protected null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
at line 19
string
address()
Canonical Dagger address of the workspace directory.
at line 28
CheckGroup
checks(array|null $include = null, bool|null $noGenerate = null, bool|null $onlyGenerate = null)
Return all checks from modules loaded in the workspace.
at line 46
string
clientId()
The client ID that owns this workspace's host filesystem.
at line 55
string
configPath()
Path to config.toml relative to the workspace boundary (empty if not initialized).
at line 66
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 directory. Absolute paths resolve from the workspace boundary.
at line 91
File
file(string $path)
Returns a File from the workspace.
Relative paths resolve from the workspace directory. Absolute paths resolve from the workspace boundary.
at line 107
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 directory.
The search stops at the workspace boundary and will not traverse above it.
at line 120
GeneratorGroup
generators(array|null $include = null)
Return all generators from modules loaded in the workspace.
at line 132
bool
hasConfig()
Whether a config.toml file exists in the workspace.
at line 141
Id
id()
A unique identifier for this Workspace.
at line 150
bool
initialized()
Whether .dagger/config.toml exists.
at line 159
string
path()
Workspace directory path relative to the workspace boundary.
at line 168
UpGroup
services(array|null $include = null)
Return all services from modules loaded in the workspace.
at line 182
Changeset
update()
Refresh workspace-managed state and return the resulting changeset.
Currently this refreshes existing lockfile entries only.