kingfisher-bin 2.8.0

MongoDB's blazingly fast and accurate secret scanning and validation tool
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use std::path::PathBuf;

use clap::{Args, ValueEnum, ValueHint};
use strum::Display;

use crate::util::get_writer_for_file_or_stdout;

// -----------------------------------------------------------------------------
// Output Options
// -----------------------------------------------------------------------------
#[derive(Args, Debug, Clone)]
#[command(next_help_heading = "Output Options")]
pub struct OutputArgs<Format: ValueEnum + Send + Sync + 'static> {
    /// Write output to the specified path (stdout if not given)
    #[arg(global = true, long, short, value_hint = ValueHint::FilePath)]
    pub output: Option<PathBuf>,

    /// Output format (defaults to `pretty`; use `toon` for LLM/agent integrations)
    #[arg(global = true, long, short, default_value = "pretty")]
    pub format: Format,
}

impl<Format: ValueEnum + Send + Sync> OutputArgs<Format> {
    /// Return a writer for the specified output destination
    pub fn get_writer(&self) -> std::io::Result<Box<dyn std::io::Write>> {
        get_writer_for_file_or_stdout(self.output.as_ref())
    }

    /// Check if an output path was specified
    pub fn has_output(&self) -> bool {
        self.output.is_some()
    }
}

// -----------------------------------------------------------------------------
// Report Output Format
// -----------------------------------------------------------------------------
#[derive(Copy, Clone, Debug, Display, PartialEq, Eq, PartialOrd, Ord, ValueEnum)]
#[strum(serialize_all = "kebab-case")]
pub enum ReportOutputFormat {
    /// A human-friendly text-based format
    Pretty,

    /// Pretty-printed JSON
    Json,

    /// JSON Lines (one JSON object per line)
    Jsonl,

    /// BSON (binary JSON) format
    Bson,

    /// TOON format optimized for LLMs and agents
    Toon,

    /// SARIF format (experimental)
    Sarif,

    /// Standalone HTML audit report
    Html,
}

// -----------------------------------------------------------------------------
// GitHub Output Format
// -----------------------------------------------------------------------------
#[derive(Copy, Clone, Debug, Display, PartialEq, Eq, PartialOrd, Ord, ValueEnum)]
#[strum(serialize_all = "kebab-case")]
pub enum GitHubOutputFormat {
    /// A human-friendly text-based format
    Pretty,

    /// Pretty-printed JSON
    Json,

    /// JSON Lines (one JSON object per line)
    Jsonl,

    /// BSON (binary JSON) format
    Bson,

    /// SARIF format (experimental)
    Sarif,
}