projects

package

Go to main page

Versions in this module

v2

v2.8.1

Aug 19, 2026

Changes in this version

type DeployImageDecision

+ PullIfStale bool

+ StaleAfter time.Duration

type ImagePullMode

+ const ImagePullModeRefresh

+ type ImagePullStep struct

+ Mode ImagePullMode

+ RefreshAfter time.Duration

v2.8.0

Aug 13, 2026

Changes in this version

+ const ErrProjectWorkspaceOutsideProjectDirectory

+ const ErrProjectWorkspaceProtectedPath

+ const ErrProjectWorkspaceRevisionConflict

+ const ErrProjectWorkspaceSymlinkPath

+ const ProjectTagMaxLength

+ const ProjectTagsPerSourceLimit

+ const ProjectWorkspaceUseScanDepth

+ func ApplyOverrideFileChange(ctx context.Context, projectsRoot, dir string, overrideContent *string) error

+ func ApplyProjectWorkspaceChanges(projectPath string, changes []project.WorkspaceFileChange, ...) error

+ func EnsureServiceImage(projectID, projectName, serviceName string, svc composetypes.ServiceConfig) (string, composetypes.ServiceConfig, bool)

+ func ExistingOrDefaultOverrideName(dir string) string

+ func FormatDockerPorts(ports []container.PortSummary) []string

+ func FormatPorts(publishers []api.PortPublisher) []string

+ func NormalizeBuildSelections(services []string) map[string]struct

+ func NormalizeProjectTag(name string) (string, error)

+ func NormalizeProjectTagColor(color projecttypes.TagColor) (projecttypes.TagColor, error)

+ func NormalizeProjectTags(names []string) ([]string, error)

+ func PrepareDeployServiceConfig(projectID, projectName, serviceName string, svc composetypes.ServiceConfig) (composetypes.ServiceConfig, string, bool)

+ func ReadProjectWorkspace(projectPath string, maxDepth int, skipDirectories, composeFileName string, ...) ([]workspacetypes.FileEntry, string, bool, error)

+ func ResolveEffectiveOverrideForValidation(dir string, overrideContent *string) (*string, string)

+ func SelectedImageRefs(compProj *composetypes.Project, servicesToUpdate []string) []string

+ func ServiceSelected(selected map[string]struct{}, name string) bool

+ func ShouldPullDeployImage(decision DeployImageDecision, exists bool) bool

type ArcaneComposeMetadata

+ ProjectTags []projecttypes.TagOption

+ ProjectTagsAuthoritative bool

type EnvMap

+ func BuildValidationEnvironment(projectsDirectory, projectPath string, effectiveEnvContent *string) (EnvMap, error)

+ func ParseValidationEnvContent(content string, contextEnv EnvMap) (EnvMap, error)

+ func ParseValidationEnvFile(path string, contextEnv EnvMap) (EnvMap, error)

+ type ProjectWorkspaceApplyOptions struct

+ ComposeFileName string

+ ExpectedRevision string

+ MaxDepth int

+ MaxEntries int

+ MaxFileSizeBytes int64

+ SkipDirectories string

v2.7.0

Aug 5, 2026

v2.6.0

Jul 29, 2026

Changes in this version

+ func LoadComposeProjectFromContent(ctx context.Context, opts projecttypes.ComposeContentOptions) (project *composetypes.Project, err error)

+ func RemapEscapedRelativeSources(ctx context.Context, pathMapper projecttypes.VolumeSourcePathMapper, ...)

+ func ResolvePathWithinDir(baseDir, path string) (string, error)

+ func VolumeSourceKey(service, target string) string

type PathMapper

+ func NewPathMapperForConfiguredDirectory(ctx context.Context, configuredPath, defaultDir string, ...) *PathMapper

v2.5.0

Jul 20, 2026

Changes in this version

+ func BuildImageRefsFromComposeProject(project *composetypes.Project) []string

v2.4.0

Jul 11, 2026

Changes in this version

+ const DefaultComposeOverrideFileName

+ const DefaultProjectFileTreeMaxEntries

+ func ComposeOverrideFileCandidates() []string

+ func DetectComposeOverrideFile(dir string) string

+ func IsFilesystemSnapshotDirName(name string) bool

+ func PathContainsSnapshotDirectory(relPath string) bool

+ func ReadComposeOverrideContent(dir string) string

+ func ResolveComposeOverride(exists func(name string) bool, read func(name string) (string, error)) (fileName string, content string, found bool, err error)

+ func RestoreProjectUpdateBackup(projectDir string, backup *ProjectUpdateBackup) error

+ func WriteComposeOverrideFile(projectsRoot, dir string, content *string, fileName string) error

type ProjectFileApplyOptions

+ MaxEntries int

+ type ProjectUpdateBackup struct

+ AbsentEntries []string

+ BackupDir string

+ DirEntries []string

+ FileEntries []string

+ RenamedDirs [][2]string

+ Skipped []string

+ TopLevelFiles bool

+ func BackupProjectUpdateScope(projectDir, backupDir string, scope ProjectUpdateBackupScope) (*ProjectUpdateBackup, error)

+ type ProjectUpdateBackupScope struct

+ Paths []string

+ RenamedDirs [][2]string

+ TopLevelFiles bool

+ func (s ProjectUpdateBackupScope) IsEmpty() bool

v2.3.2

Jul 4, 2026

Changes in this version

+ const ArcaneTrashPrefix

+ func ApplyLenientLoaderOptions(ctx context.Context, opts *loader.Options, composeFile string)

+ func BuildImagePullPlan(services composetypes.Services) map[string]ImagePullMode

+ func IsAlwaysPullPolicy(policy string) bool

+ func MarshalImageRefsJSON(refs []string) string

+ func NormalizeDeployPullPolicy(policy string) string

+ func NormalizeProjectName(name string) string

+ func NormalizePullPolicy(policy string) string

+ func ParseImageRefsJSON(raw string) []string

+ func ResolveBuildContext(workingDir string, svc composetypes.ServiceConfig, serviceName string) (string, error)

+ func ResolveDockerfilePath(svc composetypes.ServiceConfig) string

+ func RollbackRenamedProjectDirectory(oldPath, newPath string) (pathsMissing bool, err error)

+ func WithTransientValidationEnvFile(projectPath string, effectiveEnvContent *string, run func() error) (err error)

+ func WriteManagedEnvFile(projectsDirectory, projectPath, fileName string, unreadable bool, ...) error

+ type DeployImageDecision struct

+ Build bool

+ FallbackBuildOnPullFail bool

+ PullAlways bool

+ PullIfMissing bool

+ RequireLocalOnly bool

+ func DecideDeployImageAction(svc composetypes.ServiceConfig, pullPolicyOverride string) DeployImageDecision

+ type ImagePullMode int

+ const ImagePullModeAlways

+ const ImagePullModeIfMissing

+ const ImagePullModeNever

+ func ResolveServiceImagePullMode(svc composetypes.ServiceConfig) ImagePullMode

+ type MissingIncludeStubLoader struct

+ func NewMissingIncludeStubLoader(projectPath string) *MissingIncludeStubLoader

+ func (l *MissingIncludeStubLoader) Accept(path string) bool

+ func (l *MissingIncludeStubLoader) Cleanup()

+ func (l *MissingIncludeStubLoader) Dir(path string) string

+ func (l *MissingIncludeStubLoader) Load(_ context.Context, path string) (string, error)

type ProjectEnvState

+ EffectiveUnreadable bool

+ GitSourceUnreadable bool

+ OverrideUnreadable bool

v2.3.1

Jul 2, 2026

v2.3.0

Jul 1, 2026

Changes in this version

+ var ErrProjectDirExists = errors.New("project directory already exists")

+ func CreateExactDir(projectsRoot, basePath, name string, perm os.FileMode) (path, folderName string, err error)

+ func IsGitOpsScratchDirName(name string) bool

+ func IsInternalScratchDirName(name string) bool

v2.2.0

Jun 28, 2026

Changes in this version

+ func CopyDirectoryContentsTolerant(srcDir, destDir string) (skipped []string, err error)

+ func GetHostPathForContainerPath(ctx context.Context, dockerCli *client.Client, containerPath string) (string, error)

+ func MirrorDirectoryContentsPreserving(srcDir, destDir string, preserve []string) error

type HostMount

+ func GetCurrentContainerMounts(ctx context.Context, dockerCli *client.Client) ([]HostMount, error)

type SyncFile

+ Executable bool

v2.1.0

Jun 19, 2026

Changes in this version

+ const DefaultComposeFileName

+ const MaxManagedProjectFileBytes

+ const ProjectFileTreeUseScanDepth

+ var ErrProjectFileOutsideProjectDirectory = errors.New("path is outside project directory")

+ var ErrProjectFileProtectedPath = errors.New("protected project file cannot be modified")

+ var ErrProjectFileRevisionConflict = errors.New("project file tree changed; refresh the project and try again")

+ var ErrProjectFileSymlinkPath = errors.New("symlink project paths are not supported")

+ func ApplyProjectFileChanges(projectPath string, changes []project.ProjectFileChange, ...) error

+ func ApplyProjectFileDrafts(projectPath string, drafts []project.ProjectFileDraft, ...) error

+ func BuildArgsFromCompose(args map[string]*string) map[string]string

+ func BuildLocalImageTag(projectID, projectName, serviceName string) string

+ func BuildPlatformsFromCompose(svc composetypes.ServiceConfig) []string

+ func LabelsFromCompose(labels composetypes.Labels) map[string]string

+ func MergeBuildTags(primaryImage string, composeTags []string) []string

+ func NormalizeProjectRelativePath(input string) (string, error)

+ func ProtectedProjectFilePaths(composeFileName string) map[string]bool

+ func ReadProjectFileTree(projectPath string, maxDepth int, skipDirectories, composeFileName string) ([]project.ProjectFile, string, error)

+ func ResolveHostPath(mounts []HostMount, containerPath string) (string, bool)

+ func SanitizeImageComponent(value string) string

+ func UlimitsFromCompose(ulimits map[string]*composetypes.UlimitsConfig) map[string]string

+ func ValidateProjectFileName(name string) (string, error)

+ type HostMount struct

+ Destination string

+ Source string

type PathMapper

+ func NewPathMapperFromMounts(mounts []HostMount) *PathMapper

+ type ProjectFileApplyOptions struct

+ ComposeFileName string

+ ExpectedRevision string

+ MaxDepth int

+ SkipDirectories string

v2.0.3

Jun 12, 2026

Changes in this version

+ func ComposeContentProjectName(composeContent string) string

v2.0.2

Jun 10, 2026

Changes in this version

+ func MirrorDirectoryContents(srcDir, destDir string) error

v2.0.1

Jun 7, 2026

Changes in this version

+ const ArcaneIconDarkLabel

+ const ArcaneIconLabel

+ const ArcaneIconLightLabel

+ const EffectiveEnvFileName

+ const GitSourceEnvFileName

+ const GlobalEnvFileName

+ const OverrideEnvFileName

+ var ProjectFileCandidates = []string

+ func BuildAdditiveOverrideEnvContent(gitContent, localContent string) (string, error)

+ func BuildEffectiveEnvContent(gitContent, overrideContent string) (string, error)

+ func BuildOverrideEnvContent(gitContent, effectiveContent string) (string, error)

+ func CleanupRemovedFiles(projectsRoot, projectPath string, oldFiles, newFiles []string) error

+ func ComposeDown(ctx context.Context, proj *types.Project, removeVolumes bool) error

+ func ComposeFileCandidates() []string

+ func ComposeLogs(ctx context.Context, projectName string, out io.Writer, follow bool, ...) error

+ func ComposePs(ctx context.Context, proj *types.Project, services []string, all bool) ([]api.ContainerSummary, error)

+ func ComposeRestart(ctx context.Context, proj *types.Project, services []string) error

+ func ComposeStop(ctx context.Context, proj *types.Project, services []string) error

+ func ComposeUp(ctx context.Context, proj *types.Project, services []string, ...) error

+ func CopyDirectoryContents(srcDir, destDir string) error

+ func CreateUniqueDir(projectsRoot, basePath, name string, perm os.FileMode) (path, folderName string, err error)

+ func DefaultSwarmStackEnvTemplate() string

+ func DefaultSwarmStackTemplate() string

+ func DetectComposeFile(dir string) (string, error)

+ func DirectorySyncContentsChanged(projectPath string, syncFiles []SyncFile, oldSyncedFiles []string, ...) (bool, error)

+ func EnsureDefaultTemplates(ctx context.Context, configuredTemplatesDir string) error

+ func EnsureEnvFile(projectsRoot, dirPath string) error

+ func EnsureTemplateDir(ctx context.Context, templatesDir, base string) (dir, composePath, envPath string, err error)

+ func GetProjectsDirectory(ctx context.Context, projectsDir string) (string, error)

+ func GetTemplatesDirectory(ctx context.Context, templatesDir string) (string, error)

+ func HasComposeRootKeysInFile(path string) (bool, error)

+ func ImageRefsFromComposeConfigs(services []composetypes.ServiceConfig) []string

+ func ImageRefsFromComposeServices(services composetypes.Services) []string

+ func ImageRefsFromRuntimeServices(services []projecttypes.RuntimeService) []string

+ func ImportedComposeDescription(dir string) string

+ func IsBinaryProjectFileContent(content []byte) bool

+ func IsProjectDirectoryEntry(entry os.DirEntry, path string, followSymlinks bool) bool

+ func IsProjectDirectoryPath(path string, followSymlinks bool) (bool, error)

+ func IsProjectFile(filename string) bool

+ func IsSafeSubdirectory(baseDir, subdir string) bool

+ func IsWindowsDrivePath(path string) bool

+ func ListGlobalComposeContainers(ctx context.Context) ([]container.Summary, error)

+ func LoadComposeProject(ctx context.Context, composeFile, projectName, projectsDirectory string, ...) (*composetypes.Project, error)

+ func LoadComposeProjectFromDir(ctx context.Context, dir, projectName, projectsDirectory string, ...) (*composetypes.Project, string, error)

+ func LoadComposeProjectLenient(ctx context.Context, composeFile, projectName, projectsDirectory string, ...) (*composetypes.Project, error)

+ func ParseEnvContent(content string) []env.Variable

+ func ReadFolderComposeTemplate(baseDir, folder string) (string, *string, string, bool, error)

+ func ReadProjectDirectoryFiles(projectPath string, shownFiles map[string]bool, maxDepth int, ...) ([]project.IncludeFile, error)

+ func ReadProjectFiles(projectPath, composePath string) (composeContent, envContent string, err error)

+ func RemoveProjectFile(projectsRoot, dirPath, fileName string) error

+ func RemoveStaleComposeFiles(projectPath, composeFileName string, syncedFiles []string) error

+ func ResolveConfiguredContainerDirectory(configuredPath, defaultPath string) string

+ func ResolveDirectoryIdentityInternal(path string) (string, error)

+ func ResolveRelativeProjectPaths(project *composetypes.Project, workdir string)

+ func SanitizeProjectName(name string) string

+ func SaveOrUpdateProjectFiles(projectsRoot, projectPath, composeContent string, envContent *string) error

+ func Slugify(in string) string

+ func ValidateIncludePathForWrite(projectDir, includePath string) (string, error)

+ func WriteComposeFile(projectsRoot, dirPath, content string) error

+ func WriteEnvFile(projectsRoot, dirPath, content string) error

+ func WriteFileWithPerm(filePath, content string, perm os.FileMode) error

+ func WriteIncludeFile(projectDir, includePath, content string) error

+ func WriteProjectFile(projectsRoot, dirPath, fileName, content string) error

+ func WriteProjectFiles(projectsRoot, dirPath, composeContent string, envContent *string) error

+ func WriteSyncedDirectory(projectsRoot, projectPath string, files []SyncFile) ([]string, error)

+ func WriteTemplateFile(filePath, content string) error

+ func WriteTemplateFiles(composePath, envPath, composeContent, envContent string) (*string, error)

+ type ArcaneComposeMetadata struct

+ ProjectIcon IconSet

+ ProjectURLS []string

+ ServiceIconSets map[string]IconSet

+ func ParseArcaneComposeMetadata(ctx context.Context, composeFilePath, projectsDirectory string, ...) (ArcaneComposeMetadata, error)

+ func ParseArcaneComposeMetadataWithEnv(ctx context.Context, composeFilePath string, envMap map[string]string) (ArcaneComposeMetadata, error)

+ type Client struct

+ func NewClient(ctx context.Context) (*Client, error)

+ func (c *Client) Close() error

+ type DiscoveredProjectDir struct

+ DirName string

+ Path string

+ func DiscoverProjectDirectories(root string, followSymlinks bool, maxDepth int) ([]DiscoveredProjectDir, error)

+ type EnvLoader struct

+ func NewEnvLoader(projectsDir, workdir string, autoInjectEnv bool) *EnvLoader

+ func (l *EnvLoader) LoadEnvironment(ctx context.Context) (envMap EnvMap, injectionVars EnvMap, err error)

+ type EnvMap = map[string]string

+ func ParseProjectEnvContent(content string, contextEnv EnvMap) (EnvMap, error)

+ func ParseProjectEnvFile(path string, contextEnv EnvMap) (EnvMap, error)

+ type IconSet = iconcatalog.IconSet

+ func FindArcaneIconSet(labels any) IconSet

+ type IncludeFile struct

+ Content string

+ Path string

+ RelativePath string

+ func ParseIncludes(composeFilePath string, envMap EnvMap, includeContent bool) ([]IncludeFile, error)

+ func ParseIncludesFromContent(composeFilePath string, content []byte, envMap EnvMap, includeContent bool) ([]IncludeFile, error)

+ type PathMapper struct

+ func NewPathMapper(containerDir, hostDir string) *PathMapper

+ func (pm *PathMapper) ContainerToHost(containerPath string) (string, error)

+ func (pm *PathMapper) IsNonMatchingMount() bool

+ func (pm *PathMapper) TranslateVolumeSources(project *composetypes.Project) error

+ type ProgressWriterKey struct

+ type ProjectEnvMode string

+ const ProjectEnvModeDirect

+ const ProjectEnvModeOverride

+ type ProjectEnvState struct

+ DirectContent string

+ EditableContent string

+ EditableFileName string

+ EffectiveContent string

+ GitContent string

+ HasEffective bool

+ HasGitSource bool

+ HasOverride bool

+ Mode ProjectEnvMode

+ OverrideContent string

+ func ReadProjectEnvState(projectPath string) (ProjectEnvState, error)

+ type SyncFile struct

+ Content []byte

+ RelativePath string

Other modules containing this package

github.com/getarcaneapp/arcane/backend

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL