Dagger
Search

archivist

Dagger-native API for creating and extracting archives.

Installation

dagger install github.com/sagikazarmark/daggerverse/archivist@v0.4.0

Entrypoint

Return Type
Archivist
Example
func (m *myModule) example() *Archivist  {
	return dag.
			Archivist()
}
@function
def example() -> dag.Archivist:
	return (
		dag.archivist()
	)
@func()
example(): Archivist {
	return dag
		.archivist()
}

Types

Archivist 🔗

Archivist provides methods to create and extract archives.

tar() 🔗

Create and extract “.tar” archives.

Return Type
Tar !
Example
func (m *myModule) example() *ArchivistTar  {
	return dag.
			Archivist().
			Tar()
}
@function
def example() -> dag.ArchivistTar:
	return (
		dag.archivist()
		.tar()
	)
@func()
example(): ArchivistTar {
	return dag
		.archivist()
		.tar()
}

tarBr() 🔗

Create and extract “.tar.br” (and “.tbr”) archives.

Return Type
TarBr !
Example
func (m *myModule) example() *ArchivistTarBr  {
	return dag.
			Archivist().
			TarBr()
}
@function
def example() -> dag.ArchivistTarBr:
	return (
		dag.archivist()
		.tar_br()
	)
@func()
example(): ArchivistTarBr {
	return dag
		.archivist()
		.tarBr()
}

tarBz2() 🔗

Create and extract “.tar.bz2” (and “.tbz2”) archives.

Return Type
TarBz2 !
Arguments
NameTypeDefault ValueDescription
compressionLevelInteger -No description provided
Example
func (m *myModule) example() *ArchivistTarBz2  {
	return dag.
			Archivist().
			TarBz2()
}
@function
def example() -> dag.ArchivistTarBz2:
	return (
		dag.archivist()
		.tar_bz2()
	)
@func()
example(): ArchivistTarBz2 {
	return dag
		.archivist()
		.tarBz2()
}

tarGz() 🔗

Create and extract “.tar.gz” (and “.tgz”) archives.

Return Type
TarGz !
Arguments
NameTypeDefault ValueDescription
compressionLevelInteger -No description provided
Example
func (m *myModule) example() *ArchivistTarGz  {
	return dag.
			Archivist().
			TarGz()
}
@function
def example() -> dag.ArchivistTarGz:
	return (
		dag.archivist()
		.tar_gz()
	)
@func()
example(): ArchivistTarGz {
	return dag
		.archivist()
		.tarGz()
}

tarLz4() 🔗

Create and extract “.tar.lz4” (and “.tlz4”) archives.

Return Type
TarLz4 !
Example
func (m *myModule) example() *ArchivistTarLz4  {
	return dag.
			Archivist().
			TarLz4()
}
@function
def example() -> dag.ArchivistTarLz4:
	return (
		dag.archivist()
		.tar_lz4()
	)
@func()
example(): ArchivistTarLz4 {
	return dag
		.archivist()
		.tarLz4()
}

tarSz() 🔗

Create and extract “.tar.sz” (and “.tsz”) archives.

Return Type
TarSz !
Example
func (m *myModule) example() *ArchivistTarSz  {
	return dag.
			Archivist().
			TarSz()
}
@function
def example() -> dag.ArchivistTarSz:
	return (
		dag.archivist()
		.tar_sz()
	)
@func()
example(): ArchivistTarSz {
	return dag
		.archivist()
		.tarSz()
}

tarXz() 🔗

Create and extract “.tar.xz” (and “.txz”) archives.

Return Type
TarXz !
Example
func (m *myModule) example() *ArchivistTarXz  {
	return dag.
			Archivist().
			TarXz()
}
@function
def example() -> dag.ArchivistTarXz:
	return (
		dag.archivist()
		.tar_xz()
	)
@func()
example(): ArchivistTarXz {
	return dag
		.archivist()
		.tarXz()
}

tarZst() 🔗

Create and extract “.tar.zst” archives.

Return Type
TarZst !
Example
func (m *myModule) example() *ArchivistTarZst  {
	return dag.
			Archivist().
			TarZst()
}
@function
def example() -> dag.ArchivistTarZst:
	return (
		dag.archivist()
		.tar_zst()
	)
@func()
example(): ArchivistTarZst {
	return dag
		.archivist()
		.tarZst()
}

zip() 🔗

Create and extract “.zip” archives.

Return Type
Zip !
Example
func (m *myModule) example() *ArchivistZip  {
	return dag.
			Archivist().
			Zip()
}
@function
def example() -> dag.ArchivistZip:
	return (
		dag.archivist()
		.zip()
	)
@func()
example(): ArchivistZip {
	return dag
		.archivist()
		.zip()
}

Tar 🔗

Create and extract ".tar" archives.

archive() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
sourceDirectory !-No description provided
Example
func (m *myModule) example(name string, source *Directory) *File  {
	return dag.
			Archivist().
			Tar().
			Archive(name, source)
}
@function
def example(name: str, source: dagger.Directory) -> dagger.File:
	return (
		dag.archivist()
		.tar()
		.archive(name, source)
	)
@func()
example(name: string, source: Directory): File {
	return dag
		.archivist()
		.tar()
		.archive(name, source)
}

TarBr 🔗

Create and extract ".tar.br" (and ".tbr") archives.

archive() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
sourceDirectory !-No description provided
Example
func (m *myModule) example(name string, source *Directory) *File  {
	return dag.
			Archivist().
			TarBr().
			Archive(name, source)
}
@function
def example(name: str, source: dagger.Directory) -> dagger.File:
	return (
		dag.archivist()
		.tar_br()
		.archive(name, source)
	)
@func()
example(name: string, source: Directory): File {
	return dag
		.archivist()
		.tarBr()
		.archive(name, source)
}

TarBz2 🔗

Create and extract ".tar.bz2" (and ".tbz2") archives.

compressionLevel() 🔗

Return Type
Integer !
Example
func (m *myModule) example(ctx context.Context) int  {
	return dag.
			Archivist().
			TarBz2().
			CompressionLevel(ctx)
}
@function
async def example() -> int:
	return await (
		dag.archivist()
		.tar_bz2()
		.compression_level()
	)
@func()
async example(): Promise<number> {
	return dag
		.archivist()
		.tarBz2()
		.compressionLevel()
}

archive() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
sourceDirectory !-No description provided
Example
func (m *myModule) example(name string, source *Directory) *File  {
	return dag.
			Archivist().
			TarBz2().
			Archive(name, source)
}
@function
def example(name: str, source: dagger.Directory) -> dagger.File:
	return (
		dag.archivist()
		.tar_bz2()
		.archive(name, source)
	)
@func()
example(name: string, source: Directory): File {
	return dag
		.archivist()
		.tarBz2()
		.archive(name, source)
}

TarGz 🔗

Create and extract ".tar.gz" (and ".tgz") archives.

compressionLevel() 🔗

Return Type
Integer !
Example
func (m *myModule) example(ctx context.Context) int  {
	return dag.
			Archivist().
			TarGz().
			CompressionLevel(ctx)
}
@function
async def example() -> int:
	return await (
		dag.archivist()
		.tar_gz()
		.compression_level()
	)
@func()
async example(): Promise<number> {
	return dag
		.archivist()
		.tarGz()
		.compressionLevel()
}

archive() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
sourceDirectory !-No description provided
Example
func (m *myModule) example(name string, source *Directory) *File  {
	return dag.
			Archivist().
			TarGz().
			Archive(name, source)
}
@function
def example(name: str, source: dagger.Directory) -> dagger.File:
	return (
		dag.archivist()
		.tar_gz()
		.archive(name, source)
	)
@func()
example(name: string, source: Directory): File {
	return dag
		.archivist()
		.tarGz()
		.archive(name, source)
}

TarLz4 🔗

Create and extract ".tar.lz4" (and ".tlz4") archives.

archive() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
sourceDirectory !-No description provided
Example
func (m *myModule) example(name string, source *Directory) *File  {
	return dag.
			Archivist().
			TarLz4().
			Archive(name, source)
}
@function
def example(name: str, source: dagger.Directory) -> dagger.File:
	return (
		dag.archivist()
		.tar_lz4()
		.archive(name, source)
	)
@func()
example(name: string, source: Directory): File {
	return dag
		.archivist()
		.tarLz4()
		.archive(name, source)
}

TarSz 🔗

Create and extract ".tar.sz" (and ".tsz") archives.

archive() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
sourceDirectory !-No description provided
Example
func (m *myModule) example(name string, source *Directory) *File  {
	return dag.
			Archivist().
			TarSz().
			Archive(name, source)
}
@function
def example(name: str, source: dagger.Directory) -> dagger.File:
	return (
		dag.archivist()
		.tar_sz()
		.archive(name, source)
	)
@func()
example(name: string, source: Directory): File {
	return dag
		.archivist()
		.tarSz()
		.archive(name, source)
}

TarXz 🔗

Create and extract ".tar.xz" (and ".txz") archives.

archive() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
sourceDirectory !-No description provided
Example
func (m *myModule) example(name string, source *Directory) *File  {
	return dag.
			Archivist().
			TarXz().
			Archive(name, source)
}
@function
def example(name: str, source: dagger.Directory) -> dagger.File:
	return (
		dag.archivist()
		.tar_xz()
		.archive(name, source)
	)
@func()
example(name: string, source: Directory): File {
	return dag
		.archivist()
		.tarXz()
		.archive(name, source)
}

TarZst 🔗

Create and extract ".tar.zst" archives.

archive() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
sourceDirectory !-No description provided
Example
func (m *myModule) example(name string, source *Directory) *File  {
	return dag.
			Archivist().
			TarZst().
			Archive(name, source)
}
@function
def example(name: str, source: dagger.Directory) -> dagger.File:
	return (
		dag.archivist()
		.tar_zst()
		.archive(name, source)
	)
@func()
example(name: string, source: Directory): File {
	return dag
		.archivist()
		.tarZst()
		.archive(name, source)
}

Zip 🔗

Create and extract ".zip" archives.

archive() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
sourceDirectory !-No description provided
Example
func (m *myModule) example(name string, source *Directory) *File  {
	return dag.
			Archivist().
			Zip().
			Archive(name, source)
}
@function
def example(name: str, source: dagger.Directory) -> dagger.File:
	return (
		dag.archivist()
		.zip()
		.archive(name, source)
	)
@func()
example(name: string, source: Directory): File {
	return dag
		.archivist()
		.zip()
		.archive(name, source)
}