vscode-runme
Installation
Entrypoint
Types
VscodeRunme

vscode-runme

No long description provided.

Installation

dagger install github.com/stateful/vscode-runme@v3.12.5

Entrypoint

Return Type

VscodeRunme

Example

dagger -m github.com/stateful/vscode-runme@b2840251538f1a6a4074779ecd59df86a2832cb4 call \

func (m *MyModule) Example() *dagger.VscodeRunme  {
	return dag.
			VscodeRunme()
}

@function
def example() -> dagger.VscodeRunme:
	return (
		dag.vscode_runme()
	)

@func()
example(): VscodeRunme {
	return dag
		.vscodeRunme()
}

Types

VscodeRunme 🔗

directory() 🔗

The working repository directory for the VscodeRunme instance.

Return Type

Directory !

Example

dagger -m github.com/stateful/vscode-runme@b2840251538f1a6a4074779ecd59df86a2832cb4 call \
 directory

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			VscodeRunme().
			Directory()
}

@function
def example() -> dagger.Directory:
	return (
		dag.vscode_runme()
		.directory()
	)

@func()
example(): Directory {
	return dag
		.vscodeRunme()
		.directory()
}

container() 🔗

The base container being used for building the extension.

Return Type

Container !

Example

dagger -m github.com/stateful/vscode-runme@b2840251538f1a6a4074779ecd59df86a2832cb4 call \
 container

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			VscodeRunme().
			Container()
}

@function
def example() -> dagger.Container:
	return (
		dag.vscode_runme()
		.container()
	)

@func()
example(): Container {
	return dag
		.vscodeRunme()
		.container()
}

withRemote() 🔗

Build from remote git repository.

Return Type

VscodeRunme !

Arguments

Name	Type	Default Value	Description
remote	String !	-	- Valid git remote url, aka repo to clone
ref	String !	-	- Branch, tag, or commit to checkout

Example

dagger -m github.com/stateful/vscode-runme@b2840251538f1a6a4074779ecd59df86a2832cb4 call \
 with-remote --remote string --ref string

func (m *MyModule) Example(remote string, ref string) *dagger.VscodeRunme  {
	return dag.
			VscodeRunme().
			WithRemote(remote, ref)
}

@function
def example(remote: str, ref: str) -> dagger.VscodeRunme:
	return (
		dag.vscode_runme()
		.with_remote(remote, ref)
	)

@func()
example(remote: string, ref: string): VscodeRunme {
	return dag
		.vscodeRunme()
		.withRemote(remote, ref)
}

withContainer() 🔗

Sets up the container for the VscodeRunme instance.

Return Type

VscodeRunme !

Arguments

Name	Type	Default Value	Description
binary	File !	-	- Optional kernel binary file to be added to the container.
presetup	File !	-	- Optional presetup (for dependencies) file to be added to the container.

Example

dagger -m github.com/stateful/vscode-runme@b2840251538f1a6a4074779ecd59df86a2832cb4 call \
 with-container --binary file:path --presetup file:path

func (m *MyModule) Example(binary *dagger.File, presetup *dagger.File) *dagger.VscodeRunme  {
	return dag.
			VscodeRunme().
			WithContainer(binary, presetup)
}

@function
def example(binary: dagger.File, presetup: dagger.File) -> dagger.VscodeRunme:
	return (
		dag.vscode_runme()
		.with_container(binary, presetup)
	)

@func()
example(binary: File, presetup: File): VscodeRunme {
	return dag
		.vscodeRunme()
		.withContainer(binary, presetup)
}

getFile() 🔗

Sets up the container for the VscodeRunme instance.

Return Type

File !

Arguments

Name	Type	Default Value	Description
path	String !	-	- Path to file inside the container.

Example

dagger -m github.com/stateful/vscode-runme@b2840251538f1a6a4074779ecd59df86a2832cb4 call \
 get-file --path string

func (m *MyModule) Example(path string) *dagger.File  {
	return dag.
			VscodeRunme().
			GetFile(path)
}

@function
def example(path: str) -> dagger.File:
	return (
		dag.vscode_runme()
		.get_file(path)
	)

@func()
example(path: string): File {
	return dag
		.vscodeRunme()
		.getFile(path)
}

getRepoFile() 🔗

Sets up the container for the VscodeRunme instance.

Return Type

File !

Arguments

Name	Type	Default Value	Description
repo	String !	-	No description provided
path	String !	-	- Path to file inside the container.

Example

dagger -m github.com/stateful/vscode-runme@b2840251538f1a6a4074779ecd59df86a2832cb4 call \
 get-repo-file --repo string --path string

func (m *MyModule) Example(repo string, path string) *dagger.File  {
	return dag.
			VscodeRunme().
			GetRepoFile(repo, path)
}

@function
def example(repo: str, path: str) -> dagger.File:
	return (
		dag.vscode_runme()
		.get_repo_file(repo, path)
	)

@func()
example(repo: string, path: string): File {
	return dag
		.vscodeRunme()
		.getRepoFile(repo, path)
}

withSecret() 🔗

Sets up the container for the VscodeRunme instance.

Return Type

Secret !

Arguments

Name	Type	Default Value	Description
name	String !	-	- Name of the secret.
value	Secret !	-	No description provided

Example

dagger -m github.com/stateful/vscode-runme@b2840251538f1a6a4074779ecd59df86a2832cb4 call \
 with-secret --name string --value env:MYSECRET

func (m *MyModule) Example(name string, value *dagger.Secret) *dagger.Secret  {
	return dag.
			VscodeRunme().
			WithSecret(name, value)
}

@function
def example(name: str, value: dagger.Secret) -> dagger.Secret:
	return (
		dag.vscode_runme()
		.with_secret(name, value)
	)

@func()
example(name: string, value: Secret): Secret {
	return dag
		.vscodeRunme()
		.withSecret(name, value)
}

buildExtension() 🔗

Sets up the container for the VscodeRunme instance.

Return Type

File !

Arguments

Name	Type	Default Value	Description
githubTokenSecret	Secret !	-	- Valid GitHub access token for API access passed as secret.

Example

dagger -m github.com/stateful/vscode-runme@b2840251538f1a6a4074779ecd59df86a2832cb4 call \
 build-extension --github-token-secret env:MYSECRET

func (m *MyModule) Example(githubTokenSecret *dagger.Secret) *dagger.File  {
	return dag.
			VscodeRunme().
			BuildExtension(githubTokenSecret)
}

@function
def example(github_token_secret: dagger.Secret) -> dagger.File:
	return (
		dag.vscode_runme()
		.build_extension(github_token_secret)
	)

@func()
example(githubTokenSecret: Secret): File {
	return dag
		.vscodeRunme()
		.buildExtension(githubTokenSecret)
}