Dagger
Search

archivist

Dagger-native API for creating and extracting archives.

Installation

dagger install github.com/luanmtruong/daggerverse/archivist@96c13b929c636316317f745ff36cda4e4c66f680

Entrypoint

Return Type
Archivist
Example
func (m *myModule) 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()
}

tarBr() πŸ”—

Create and extract β€œ.tar.br” (and β€œ.tbr”) archives.

Return Type
TarBr !
Example
func (m *myModule) 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()
}

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()
}

tarLz4() πŸ”—

Create and extract β€œ.tar.lz4” (and β€œ.tlz4”) archives.

Return Type
TarLz4 !
Example
func (m *myModule) 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()
}

tarXz() πŸ”—

Create and extract β€œ.tar.xz” (and β€œ.txz”) archives.

Return Type
TarXz !
Example
func (m *myModule) 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()
}

zip() πŸ”—

Create and extract β€œ.zip” archives.

Return Type
Zip !
Example
func (m *myModule) 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)
}

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)
}

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)
}

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)
}

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)
}

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)
}

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)
}

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)
}

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)
}

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)
}

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)
}