Dagger
Search

poutine

Supply Chain Vulnerability Scanner for Build Pipelines by BoostSecurity.io

Installation

dagger install github.com/boostsecurityio/poutine@49b9418e7c4a483727ef677815736cd5c39929a0

Entrypoint

Return Type
Poutine !
Arguments
NameTypeDescription
configString Path to the configuration file
configSrcDirectory Directory containing additional configuration files
formatString Output format (pretty, json, sarif)
scmString SCM platform
scmBaseUrlString Base URI of the self-hosted SCM platform
threadsString The number of threads to use for analysis
versionString Version of poutine to use
Example
func (m *myModule) example() *Poutine  {
	return dag.
			Poutine()
}
@function
def example() -> dag.Poutine:
	return (
		dag.poutine()
	)
@func()
example(): Poutine {
	return dag
		.poutine()
}

Types

Poutine 🔗

Poutine analysis options

config() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Poutine().
			Config(ctx)
}
@function
async def example() -> str:
	return await (
		dag.poutine()
		.config()
	)
@func()
async example(): Promise<string> {
	return dag
		.poutine()
		.config()
}

configSrc() 🔗

Return Type
Directory !
Example
func (m *myModule) example() *Directory  {
	return dag.
			Poutine().
			ConfigSrc()
}
@function
def example() -> dagger.Directory:
	return (
		dag.poutine()
		.config_src()
	)
@func()
example(): Directory {
	return dag
		.poutine()
		.configSrc()
}

format() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Poutine().
			Format(ctx)
}
@function
async def example() -> str:
	return await (
		dag.poutine()
		.format()
	)
@func()
async example(): Promise<string> {
	return dag
		.poutine()
		.format()
}

scm() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Poutine().
			Scm(ctx)
}
@function
async def example() -> str:
	return await (
		dag.poutine()
		.scm()
	)
@func()
async example(): Promise<string> {
	return dag
		.poutine()
		.scm()
}

scmBaseUrl() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Poutine().
			ScmBaseUrl(ctx)
}
@function
async def example() -> str:
	return await (
		dag.poutine()
		.scm_base_url()
	)
@func()
async example(): Promise<string> {
	return dag
		.poutine()
		.scmBaseUrl()
}

threads() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Poutine().
			Threads(ctx)
}
@function
async def example() -> str:
	return await (
		dag.poutine()
		.threads()
	)
@func()
async example(): Promise<string> {
	return dag
		.poutine()
		.threads()
}

version() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Poutine().
			Version(ctx)
}
@function
async def example() -> str:
	return await (
		dag.poutine()
		.version()
	)
@func()
async example(): Promise<string> {
	return dag
		.poutine()
		.version()
}

quiet() 🔗

Return Type
Boolean !
Example
func (m *myModule) example(ctx context.Context) bool  {
	return dag.
			Poutine().
			Quiet(ctx)
}
@function
async def example() -> bool:
	return await (
		dag.poutine()
		.quiet()
	)
@func()
async example(): Promise<boolean> {
	return dag
		.poutine()
		.quiet()
}

container() 🔗

Return Type
Container !
Example
func (m *myModule) example() *Container  {
	return dag.
			Poutine().
			Container()
}
@function
def example() -> dagger.Container:
	return (
		dag.poutine()
		.container()
	)
@func()
example(): Container {
	return dag
		.poutine()
		.container()
}

analyzeLocal() 🔗

Analyze a Git repository in a directory

Return Type
String !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
Example
func (m *myModule) example(ctx context.Context, src *Directory) string  {
	return dag.
			Poutine().
			AnalyzeLocal(ctx, src)
}
@function
async def example(src: dagger.Directory) -> str:
	return await (
		dag.poutine()
		.analyze_local(src)
	)
@func()
async example(src: Directory): Promise<string> {
	return dag
		.poutine()
		.analyzeLocal(src)
}

analyzeRepo() 🔗

Analyze a remote repository

Return Type
String !
Arguments
NameTypeDefault ValueDescription
repoString !-Repository to analyze in the format owner/repo
tokenSecret !-SCM access token
refString -Git ref to analyze
Example
func (m *myModule) example(ctx context.Context, repo string, token *Secret) string  {
	return dag.
			Poutine().
			AnalyzeRepo(ctx, repo, token)
}
@function
async def example(repo: str, token: dagger.Secret) -> str:
	return await (
		dag.poutine()
		.analyze_repo(repo, token)
	)
@func()
async example(repo: string, token: Secret): Promise<string> {
	return dag
		.poutine()
		.analyzeRepo(repo, token)
}

analyzeOrg() 🔗

Analyze an organization’s repositories

Return Type
String !
Arguments
NameTypeDefault ValueDescription
orgString !-Organization name
tokenSecret !-SCM access token
ignoreForksBoolean -Ignore forked repositories
Example
func (m *myModule) example(ctx context.Context, org string, token *Secret) string  {
	return dag.
			Poutine().
			AnalyzeOrg(ctx, org, token)
}
@function
async def example(org: str, token: dagger.Secret) -> str:
	return await (
		dag.poutine()
		.analyze_org(org, token)
	)
@func()
async example(org: string, token: Secret): Promise<string> {
	return dag
		.poutine()
		.analyzeOrg(org, token)
}