Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/docker/compose
/ types & classes
Types & classes
271 in github.com/docker/compose
⨍
Functions
2,102
◇
Types & classes
271
↓ 4 callers
TypeAlias
FileEvent
pkg/watch/notify.go:29
↓ 2 callers
TypeAlias
Containers
Containers is a set of moby Container
pkg/compose/containers.go:35
↓ 1 callers
TypeAlias
ImagePruneMode
ImagePruneMode controls how aggressively images associated with the project are removed from the engine.
pkg/compose/image_pruner.go:37
↓ 1 callers
TypeAlias
OCIVersion
OCIVersion controls manifest generation to ensure compatibility with different registries. Currently, this is not exposed as an option to the user –
pkg/api/api.go:484
↓ 1 callers
TypeAlias
OperationType
OperationType identifies the kind of atomic operation in a reconciliation plan. Each operation maps to exactly one Docker API call.
pkg/compose/plan.go:32
↓ 1 callers
TypeAlias
oneOff
pkg/compose/containers.go:37
↓ 1 callers
Struct
printer
pkg/compose/printer.go:30
Struct
AnyMatcher
AnyMatcher is a PathMatcher to match any path
pkg/watch/notify.go:68
Struct
ArchiveBuilder
internal/sync/tar.go:123
Struct
AttachOptions
AttachOptions group options of the Attach API
pkg/api/api.go:442
Struct
AvailableModel
pkg/compose/model.go:265
Struct
BackendOptions
cmd/compose/compose.go:419
Struct
BuildOptions
BuildOptions group options of the Build API
pkg/api/api.go:194
Struct
CLI
CLI is used to wrap the CLI for end to end testing
pkg/e2e/framework.go:71
FuncType
CLIOption
CLIOption to customize behavior for all commands for a CLI instance.
pkg/e2e/framework.go:85
TypeAlias
Cascade
pkg/api/api.go:306
Struct
Client
Client for integration with Docker Desktop features.
internal/desktop/client.go:75
FuncType
CobraCommand
CobraCommand defines a cobra command function
cmd/compose/compose.go:104
FuncType
Command
Command defines a compose CLI command as a func with args
cmd/compose/compose.go:101
Struct
CommandMetadata
pkg/compose/plugins.go:292
Struct
CommandMetadata
docs/examples/provider.go:158
Struct
CommitOptions
CommitOptions group options of the Commit API
pkg/api/api.go:651
Interface
Compose
Compose is the API interface one can use to programmatically use docker/compose in a third-party software Use [compose.NewComposeService] to get an ac
pkg/api/api.go:83
Struct
CompositePathMatcher
pkg/watch/notify.go:102
Struct
ConfigOptions
ConfigOptions group options of the Config API
pkg/api/api.go:359
Struct
ContainerContext
ContainerContext is a struct used for rendering a list of containers in a Go template.
cmd/formatter/container.go:100
Struct
ContainerEvent
ContainerEvent notify an event has been collected on source container implementing Service
pkg/api/api.go:714
FuncType
ContainerEventListener
ContainerEventListener is a callback to process ContainerEvent from services
pkg/api/api.go:711
Struct
ContainerProcSummary
ContainerProcSummary holds container processes top data
pkg/api/api.go:593
Struct
ContainerStdin
ContainerStdin implement WriteCloser for moby.HijackedResponse
pkg/compose/container.go:46
Struct
ContainerStdout
ContainerStdout implement ReadCloser for moby.HijackedResponse
pkg/compose/container.go:28
Struct
ContainerSummary
ContainerSummary hold high-level description of a container
pkg/api/api.go:541
Interface
ContextInfo
ContextInfo provides Docker context information for advanced scenarios
pkg/api/context.go:20
Struct
ConvertOptions
pkg/bridge/convert.go:45
Struct
CopyOptions
CopyOptions group options of the cp API
pkg/api/api.go:523
Struct
CreateOptions
CreateOptions group options of the Create API
pkg/api/api.go:263
Struct
CreateTransformerOptions
pkg/bridge/transformers.go:38
Struct
DownOptions
DownOptions group options of the Down API
pkg/api/api.go:343
Struct
DryRunClient
DryRunClient implements APIClient by delegating to implementation functions. This allows lazy init and per-method overrides
pkg/dryrun/dryrunclient.go:46
Struct
EmptyMatcher
EmptyMatcher is a PathMatcher to match no path
pkg/watch/notify.go:76
Struct
Event
Event is a container runtime event served by Events API
pkg/api/api.go:460
Interface
EventProcessor
EventProcessor is notified about Compose operations and tasks
pkg/api/event.go:100
TypeAlias
EventStatus
EventStatus indicates the status of an action
pkg/api/event.go:24
Struct
EventsOptions
EventsOptions group options of the Events API
pkg/api/api.go:452
Struct
ExportOptions
ExportOptions group options of the Export API
pkg/api/api.go:644
Interface
Feature
Feature is an compose feature that can be started/stopped by a menu command
cmd/formatter/shortcut.go:80
TypeAlias
FeatureFlagResponse
internal/desktop/client.go:137
Struct
FeatureFlagValue
internal/desktop/client.go:139
Struct
GenerateOptions
pkg/api/api.go:663
Struct
Graph
Graph represents project as service dependencies
pkg/compose/dependencies.go:208
Struct
ImagePruneOptions
ImagePruneOptions controls the behavior of image pruning.
pkg/compose/image_pruner.go:51
Struct
ImagePruner
ImagePruner handles image removal during Compose `down` operations.
pkg/compose/image_pruner.go:60
Struct
ImageSummary
ImageSummary holds container image description
pkg/api/api.go:603
Struct
ImagesOptions
ImagesOptions group options of the Images API
pkg/api/api.go:383
Struct
JsonMessage
pkg/compose/plugins.go:42
TypeAlias
KEYBOARD_LOG_LEVEL
cmd/formatter/shortcut.go:85
Struct
KeyboardError
cmd/formatter/shortcut.go:41
Struct
KeyboardWatch
cmd/formatter/shortcut.go:74
Struct
KillOptions
KillOptions group options of the Kill API
pkg/api/api.go:388
Struct
ListOptions
ListOptions group options of the ls API
pkg/api/api.go:511
FuncType
LoadListener
LoadListener receives events during project loading. Events include: - "extends": when a service extends another (metadata: service info) - "include":
pkg/api/api.go:41
Interface
LogConsumer
LogConsumer is a callback to process log messages from services
pkg/api/api.go:704
Struct
LogKeyboard
cmd/formatter/shortcut.go:93
Struct
LogOptions
LogOptions defines optional parameters for the `Log` API
pkg/api/api.go:624
Interface
LowLevelClient
internal/sync/tar.go:45
Struct
Metadata
docs/examples/provider.go:162
Struct
Metrics
internal/tracing/attributes.go:39
Struct
MetricsKey
internal/tracing/attributes.go:37
Struct
MockAPIClient
MockAPIClient is a mock of APIClient interface.
pkg/mocks/mock_docker_api.go:23
Struct
MockAPIClientMockRecorder
MockAPIClientMockRecorder is the mock recorder for MockAPIClient.
pkg/mocks/mock_docker_api.go:29
Struct
MockCli
MockCli is a mock of Cli interface.
pkg/mocks/mock_docker_cli.go:28
Struct
MockCliMockRecorder
MockCliMockRecorder is the mock recorder for MockCli.
pkg/mocks/mock_docker_cli.go:34
Struct
MockCompose
MockCompose is a mock of Compose interface.
pkg/mocks/mock_docker_compose_api.go:22
Struct
MockComposeMockRecorder
MockComposeMockRecorder is the mock recorder for MockCompose.
pkg/mocks/mock_docker_compose_api.go:28
Struct
MockLogConsumer
MockLogConsumer is a mock of LogConsumer interface.
pkg/mocks/mock_docker_compose_api.go:534
Struct
MockLogConsumerMockRecorder
MockLogConsumerMockRecorder is the mock recorder for MockLogConsumer.
pkg/mocks/mock_docker_compose_api.go:540
Struct
MockUI
MockUI is a mock of UI interface
cmd/prompt/prompt_mock.go:14
Struct
MockUIMockRecorder
MockUIMockRecorder is the mock recorder for MockUI
cmd/prompt/prompt_mock.go:20
Struct
Model
pkg/compose/model.go:240
Struct
MuxExporter
internal/tracing/mux.go:27
Interface
Notify
pkg/watch/notify.go:38
Struct
OCIOptions
pkg/api/api.go:77
Struct
OTLPConfig
OTLPConfig contains the necessary values to initialize an OTLP client manually. This supports a minimal set of options based on what is necessary for
internal/tracing/tracing.go:52
Struct
ObservedContainer
ObservedContainer holds the relevant state extracted from a running or stopped container, with label values pre-parsed for efficient comparison.
pkg/compose/observed_state.go:45
Struct
ObservedNetwork
ObservedNetwork holds the state of a Docker network that belongs to the project, identified by the com.docker.compose.network label.
pkg/compose/observed_state.go:64
Struct
ObservedState
ObservedState captures the current state of all Docker resources belonging to a Compose project. It is a snapshot taken before reconciliation so that
pkg/compose/observed_state.go:35
Struct
ObservedVolume
ObservedVolume holds the state of a Docker volume that belongs to the project, identified by the com.docker.compose.volume label.
pkg/compose/observed_state.go:73
Struct
Operation
Operation describes a single atomic action to be performed by the executor.
pkg/compose/plan.go:91
FuncType
Option
func(service *composeService) error
pkg/compose/compose.go:44
Struct
ParameterMetadata
pkg/compose/plugins.go:296
Struct
PathMapping
PathMapping contains the Compose service and modified host system path.
internal/sync/shared.go:22
Interface
PathMatcher
When we specify directories to watch, we often want to ignore some subset of the files under those directories. For example: - Watch /src/repo, but i
pkg/watch/notify.go:60
Struct
PauseOptions
PauseOptions group options of the Pause API
pkg/api/api.go:636
Struct
Pidfile
internal/locker/pidfile.go:24
Struct
PingResponse
internal/desktop/client.go:107
Struct
Pipe
Pipe - aggregates prompt methods
cmd/prompt/prompt.go:91
Struct
Plan
Plan is a directed acyclic graph of operations produced by the reconciler. Nodes are stored in topological order (dependencies before dependents).
pkg/compose/plan.go:119
Struct
PlanNode
PlanNode is a single node in the reconciliation DAG. It represents one atomic operation and its dependencies on other nodes.
pkg/compose/plan.go:110
Struct
PortOptions
PortOptions group options of the Port API
pkg/api/api.go:469
Struct
PortPublisher
PortPublisher hold status about published port
pkg/api/api.go:533
next →
1–100 of 271, ranked by callers