arc
Installation
Entrypoint
Types
Arc
Archive

arc

Easily create & extract archives, and compress & decompress files of various formats.

Installation

dagger install github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9

Entrypoint

Return Type

Arc !

Arguments

Name	Type	Description
version	String	Version to download from GitHub Releases (default: "3.5.0").
image	String	Custom image reference in "repository:tag" format to use as a base container.
container	Container	Custom container to use as a base container.

Example

func (m *myModule) example() *Arc  {
	return dag.
			Arc()
}

@function
def example() -> dag.Arc:
	return (
		dag.arc()
	)

@func()
example(): Arc {
	return dag
		.arc()
}

Types

Arc

Easily create & extract archives, and compress & decompress files of various formats.

archiveFiles()

Create a new archive from a list of files.

Return Type

Archive !

Arguments

Name	Type	Default Value	Description
name	String !	-	File name without extension.
files	[File ! ] !	-	Files to archive.

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-files --name string \
 create --format string

func (m *myModule) example(name string, files []*File) *ArcArchive  {
	return dag.
			Arc().
			ArchiveFiles(name, files)
}

@function
def example(name: str, files: List[dagger.File]) -> dag.ArcArchive:
	return (
		dag.arc()
		.archive_files(name, files)
	)

@func()
example(name: string, files: File[]): ArcArchive {
	return dag
		.arc()
		.archiveFiles(name, files)
}

archiveDirectory()

Create a new archive from the contents of a directory.

Return Type

Archive !

Arguments

Name	Type	Default Value	Description
name	String !	-	File name without extension.
directory	Directory !	-	Directory to archive.

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 create --format string

func (m *myModule) example(name string, directory *Directory) *ArcArchive  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory)
}

@function
def example(name: str, directory: dagger.Directory) -> dag.ArcArchive:
	return (
		dag.arc()
		.archive_directory(name, directory)
	)

@func()
example(name: string, directory: Directory): ArcArchive {
	return dag
		.arc()
		.archiveDirectory(name, directory)
}

unarchive()

Extract the contents of an archive.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
archive	File !	-	Archive file (in one of the supported formats).

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 unarchive --archive file:path

func (m *myModule) example(archive *File) *Directory  {
	return dag.
			Arc().
			Unarchive(archive)
}

@function
def example(archive: dagger.File) -> dagger.Directory:
	return (
		dag.arc()
		.unarchive(archive)
	)

@func()
example(archive: File): Directory {
	return dag
		.arc()
		.unarchive(archive)
}

Archive

name()

File name of the archive (without extension).

Return Type

String !

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 name

func (m *myModule) example(ctx context.Context, name string, directory *Directory) string  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			Name(ctx)
}

@function
async def example(name: str, directory: dagger.Directory) -> str:
	return await (
		dag.arc()
		.archive_directory(name, directory)
		.name()
	)

@func()
async example(name: string, directory: Directory): Promise<string> {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.name()
}

create()

Create an archive from the provided files or directory.

Return Type

File !

Arguments

Name	Type	Default Value	Description
format	String !	-	One of the supported archive formats. (choices: "zip", "tar", "tar.br", "tbr", "tar.gz", "tgz", "tar.bz2", "tbz2", "tar.xz", "txz", "tar.lz4", "tlz4", "tar.sz", "tsz", "tar.zst")

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 create --format string

func (m *myModule) example(name string, directory *Directory, format string) *File  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			Create(format)
}

@function
def example(name: str, directory: dagger.Directory, format: str) -> dagger.File:
	return (
		dag.arc()
		.archive_directory(name, directory)
		.create(format)
	)

@func()
example(name: string, directory: Directory, format: string): File {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.create(format)
}

tar()

Return Type

File !

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 tar

func (m *myModule) example(name string, directory *Directory) *File  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			Tar()
}

@function
def example(name: str, directory: dagger.Directory) -> dagger.File:
	return (
		dag.arc()
		.archive_directory(name, directory)
		.tar()
	)

@func()
example(name: string, directory: Directory): File {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.tar()
}

tarBr()

Return Type

File !

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 tar-br

func (m *myModule) example(name string, directory *Directory) *File  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			TarBr()
}

@function
def example(name: str, directory: dagger.Directory) -> dagger.File:
	return (
		dag.arc()
		.archive_directory(name, directory)
		.tar_br()
	)

@func()
example(name: string, directory: Directory): File {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.tarBr()
}

tarBz2()

Return Type

File !

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 tar-bz2

func (m *myModule) example(name string, directory *Directory) *File  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			TarBz2()
}

@function
def example(name: str, directory: dagger.Directory) -> dagger.File:
	return (
		dag.arc()
		.archive_directory(name, directory)
		.tar_bz2()
	)

@func()
example(name: string, directory: Directory): File {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.tarBz2()
}

tarGz()

Return Type

File !

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 tar-gz

func (m *myModule) example(name string, directory *Directory) *File  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			TarGz()
}

@function
def example(name: str, directory: dagger.Directory) -> dagger.File:
	return (
		dag.arc()
		.archive_directory(name, directory)
		.tar_gz()
	)

@func()
example(name: string, directory: Directory): File {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.tarGz()
}

tarLz4()

Return Type

File !

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 tar-lz4

func (m *myModule) example(name string, directory *Directory) *File  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			TarLz4()
}

@function
def example(name: str, directory: dagger.Directory) -> dagger.File:
	return (
		dag.arc()
		.archive_directory(name, directory)
		.tar_lz4()
	)

@func()
example(name: string, directory: Directory): File {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.tarLz4()
}

tarSz()

Return Type

File !

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 tar-sz

func (m *myModule) example(name string, directory *Directory) *File  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			TarSz()
}

@function
def example(name: str, directory: dagger.Directory) -> dagger.File:
	return (
		dag.arc()
		.archive_directory(name, directory)
		.tar_sz()
	)

@func()
example(name: string, directory: Directory): File {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.tarSz()
}

tarXz()

Return Type

File !

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 tar-xz

func (m *myModule) example(name string, directory *Directory) *File  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			TarXz()
}

@function
def example(name: str, directory: dagger.Directory) -> dagger.File:
	return (
		dag.arc()
		.archive_directory(name, directory)
		.tar_xz()
	)

@func()
example(name: string, directory: Directory): File {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.tarXz()
}

tarZst()

Return Type

File !

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 tar-zst

func (m *myModule) example(name string, directory *Directory) *File  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			TarZst()
}

@function
def example(name: str, directory: dagger.Directory) -> dagger.File:
	return (
		dag.arc()
		.archive_directory(name, directory)
		.tar_zst()
	)

@func()
example(name: string, directory: Directory): File {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.tarZst()
}

zip()

Return Type

File !

Example

dagger -m github.com/sagikazarmark/daggerverse/arc@833905febeb1c77937712dd9f69a2c85898c74d9 call \
 archive-directory --name string --directory DIR_PATH \
 zip

func (m *myModule) example(name string, directory *Directory) *File  {
	return dag.
			Arc().
			ArchiveDirectory(name, directory).
			Zip()
}

@function
def example(name: str, directory: dagger.Directory) -> dagger.File:
	return (
		dag.arc()
		.archive_directory(name, directory)
		.zip()
	)

@func()
example(name: string, directory: Directory): File {
	return dag
		.arc()
		.archiveDirectory(name, directory)
		.zip()
}