TruffleHog #
Native WebAssembly component written in PureScript. Requires FluentCI v0.17.3+. Function signatures and argument descriptions come from the compiled PureScript source and are embedded in the component; no raw JSON plugin input is required.
Usage #
fluentci run trufflehog filesystem --project . --run-dir .fluentci/runs/trufflehog-001
fluentci run trufflehog --help
fluentci run trufflehog filesystem --help
See COMPONENT.md for every named argument, description, required flag, and return type. The schema describes the same contract. Optional values retain the native module defaults. Lists use JSON array syntax; boolean arguments accept switches. Native function/flag names use kebab-case.
Requirements and behavior #
Install a current TruffleHog 3 CLI supporting --fail-on-scan-errors. Named scans disable updates and credential verification, and fail on results or scan errors. Remote Git repositories still require network access and authentication. TruffleHog JSON output may contain raw detected values; protect task logs and reports. The generic run export permits other native modes, including verification if explicitly requested in arguments.
The return value is a typed record containing outcome, run-dir, report-path,
stdout-path, and stderr-path. Each invocation needs a fresh run directory.
Native command failures, cancellation, and timeouts fail the component call.
Use --artifacts '["package=dist/package.zip"]' to declare output files for the
execution report. Authentication stays in native configuration or host environment.
Development #
From this module directory, with Node.js, Bun, PureScript, and Spago installed:
bun install --cwd ../../lib/component --frozen-lockfile
npm ci
npm run build
npm test
dist/plugin.wasm is the native component; dist/fluentci.metadata.json is its
checksummed contract sidecar. The CJS bundles and legacy-entry.mjs exist only for
private regression tests and are not the published module interface.
See the component migration guide and MIT License.
Setup component dependency #
This module declares setup-trufflehog as typed native component dependencies.
FluentCI v0.17.3+ resolves their source references while building and composes
them into the published Wasm. Consumers need no relative source paths.
Available tools are reused; missing prerequisites invoke setup with default
arguments. Explicit executable overrides remain caller-managed. Configure pinned
versions or privileged/custom installations in an earlier setup step.
See dependency behavior and publishing for
command-specific prerequisites, validation, credential skips, and CI coverage.
Compose this module from code #
Requires FluentCI 0.17.6 or newer for generated pipeline bindings. From your caller module's directory, add the dependency:
fluentci add trufflehog --path /path/to/fluentci-modules/security/trufflehog
For a published module, use fluentci add @fluentci.io/trufflehog@VERSION with an
available version. Commit the caller's manifest and lockfile. FluentCI generates
named bindings from the installed component's WIT; no handwritten FFI or CLI
subprocess is needed. Include generated source directories in the caller's SDK
project. The callee can use a different SDK from the caller.
Scan local files for secrets without verifying credentials against remote services.
Replace the sample organization, paths and identifiers with your own. Configure credentials through your CI secret provider before running authenticated operations. Optional arguments use the callee's defaults, and public list fields use comma-separated strings. See COMPONENT.md for argument descriptions and return types.
These examples use the generated composition API and builder chaining in FluentCI 0.17.6; full cross-SDK compilation and execution coverage is still pending. See composition support and limitations.
PureScript #
module Main where
import Prelude
import Effect (Effect)
import FluentCI.Flow as Flow
import FluentCI.Modules.Trufflehog as Trufflehog
run :: Effect String
run =
Flow.pipeline "trufflehog-filesystem"
# Flow.workdir "."
# Trufflehog.filesystem (Trufflehog.filesystemArgs)
# Flow.map (\result -> result.reportPath)
# Flow.run
Gleam #
import fluentci/flow
import fluentci_modules/trufflehog
pub fn run() -> String {
flow.pipeline("trufflehog-filesystem")
|> flow.workdir(".")
|> trufflehog.filesystem(trufflehog.filesystem_args())
|> flow.map(fn(result) { result.report_path })
|> flow.run
}
Use Gleam's JavaScript target for the Wasm guest. BEAM escripts used for repository automation are separate from component guests.
Elixir #
defmodule Main do
use FluentCI.Plugin
alias FluentCI.Flow
alias FluentCI.Modules.Trufflehog
defplugin run do
Flow.pipeline("trufflehog-filesystem")
|> Flow.workdir(".")
|> Trufflehog.filesystem(%{})
|> Flow.stdout()
end
end
Elixir compiles this sequence to Rust/Wasm. Its initial Flow API does not yet provide the typed result callbacks or cleanup combinators of the other examples.
ClojureScript #
(ns main.plugin
(:require [fluentci.flow :as flow]
[fluentci-modules.trufflehog :as trufflehog]))
(defn run []
(-> (flow/pipeline "trufflehog-filesystem")
(flow/workdir ".")
(trufflehog/filesystem {})
flow/run!))
ReScript #
let run = (): string =>
Flow.pipeline("trufflehog-filesystem")
->Flow.workdir(".")
->FluentciModulesTrufflehog.filesystem(FluentciModulesTrufflehog.filesystemArgs)
->Flow.map(result => result.reportPath)
->Flow.run
Python #
from fluentci.flow import pipeline
from fluentci_modules import trufflehog
def run() -> str:
return (
pipeline("trufflehog-filesystem")
.workdir(".")
.pipe(trufflehog.filesystem, {})
.map(lambda result: result.report_path)
.run()
)
TypeScript #
import * as flow from "./fluentci_modules/flow";
import * as trufflehog from "./fluentci_modules/trufflehog/index";
export function run(): string {
return flow.pipeline("trufflehog-filesystem")
.workdir(".")
.pipe(trufflehog.filesystem, {})
.map(result => result.reportPath)
.run();
}
Python and TypeScript use FluentCI builder chains: .pipe(module.function, args)
composes generated module functions with .workdir, .env, and .exec.
Functions return a pipeline carrying their typed result. Use a generated result
callback (With/_with, or a callback argument in TypeScript/Python) when a later
module needs a preceding result; use Flow's map operation to select a result field.
Execution begins at run (or the Elixir plugin terminal), in declared order.
Exported functions #
| Function | Purpose |
|---|---|
run |
Execute arbitrary literal CLI arguments. |
version |
Print the CLI version. |
filesystem |
Scan local files for secrets without verifying credentials against remote services. |
git |
Scan a Git repository without credential verification. |