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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
use clap::{Args, Parser, Subcommand};
use serde::Deserialize;
#[derive(Debug, Clone, Copy, clap::ValueEnum, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum OutputFormat {
Terminal,
Json,
Sarif,
}
#[derive(Debug, Clone, Copy, clap::ValueEnum, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum SeverityFilter {
Low,
Medium,
High,
Critical,
}
#[derive(Args, Debug, Clone)]
pub struct ScanArgs {
/// Path to scan
#[arg(default_value = ".")]
pub path: String,
/// Path to foxguard config file
#[arg(long)]
pub config: Option<String>,
/// Output format
#[arg(short, long, value_enum, default_value = "terminal")]
pub format: OutputFormat,
/// Minimum severity to report
#[arg(short, long, value_enum)]
pub severity: Option<SeverityFilter>,
/// Path to Semgrep YAML rule file or directory
#[arg(short, long)]
pub rules: Option<String>,
/// Disable built-in rules and run only external rules loaded via --rules
#[arg(long, default_value_t = false)]
pub no_builtins: bool,
/// Scan changed files only (staged first, then unstaged)
#[arg(long, default_value_t = false)]
pub changed: bool,
/// Exclude scan-relative paths by glob or prefix (repeatable)
#[arg(long)]
pub exclude: Vec<String>,
/// Apply a baseline file to suppress known findings
#[arg(long)]
pub baseline: Option<String>,
/// Write the current findings to a baseline file
#[arg(long)]
pub write_baseline: Option<String>,
/// Show source-to-sink dataflow traces on taint findings
#[arg(long, default_value_t = false)]
pub explain: bool,
/// Auto-fix supported taint findings (writes changes to disk)
#[arg(long, default_value_t = false)]
pub fix: bool,
/// Post findings as inline review comments on a GitHub PR
#[arg(long)]
pub github_pr: Option<u64>,
/// Suppress terminal output (exit code still reflects findings)
#[arg(short, long)]
pub quiet: bool,
/// Maximum file size in bytes to scan (default: 1 MB)
#[arg(long, default_value_t = 1_048_576)]
pub max_file_size: u64,
}
#[derive(Args, Debug, Clone)]
pub struct InitArgs {
/// Repository path where the hook should be installed
#[arg(long, default_value = ".")]
pub path: String,
/// Config file path relative to the repo
#[arg(long, default_value = ".foxguard.yml")]
pub config_path: String,
/// Hook file path relative to the repo
#[arg(long, default_value = ".git/hooks/pre-commit")]
pub hook_path: String,
/// Baseline path relative to the repo
#[arg(long, default_value = ".foxguard/baseline.json")]
pub baseline: String,
/// Secrets baseline path relative to the repo
#[arg(long, default_value = ".foxguard/secrets-baseline.json")]
pub secrets_baseline: String,
/// Do not create an initial baseline file
#[arg(long, default_value_t = false)]
pub no_baseline: bool,
/// Overwrite an existing hook file
#[arg(long, default_value_t = false)]
pub force: bool,
}
#[derive(Args, Debug, Clone)]
pub struct BaselineArgs {
#[command(flatten)]
pub scan: ScanArgs,
/// Output path for the baseline file
#[arg(long, default_value = ".foxguard/baseline.json")]
pub output: String,
}
#[derive(Args, Debug, Clone)]
pub struct SecretsArgs {
/// Path to scan
#[arg(default_value = ".")]
pub path: String,
/// Path to foxguard config file
#[arg(long)]
pub config: Option<String>,
/// Output format
#[arg(short, long, value_enum, default_value = "terminal")]
pub format: OutputFormat,
/// Scan changed files only (staged first, then unstaged)
#[arg(long, default_value_t = false)]
pub changed: bool,
/// Apply a baseline file to suppress known findings
#[arg(long)]
pub baseline: Option<String>,
/// Write the current findings to a baseline file
#[arg(long)]
pub write_baseline: Option<String>,
/// Exclude a file or directory prefix from secrets scanning (repeatable)
#[arg(long = "exclude-path")]
pub exclude_paths: Vec<String>,
/// Load excluded file or directory prefixes from a newline-delimited file
#[arg(long)]
pub exclude_path_file: Option<String>,
/// Ignore a specific built-in secrets rule ID (repeatable)
#[arg(long = "ignore-rule")]
pub ignored_rules: Vec<String>,
/// Maximum file size in bytes to scan (default: 1 MB)
#[arg(long, default_value_t = 1_048_576)]
pub max_file_size: u64,
}
#[derive(Args, Debug, Clone)]
pub struct DiffArgs {
/// Target branch to compare against (e.g., "main", "origin/main")
#[arg()]
pub target: String,
/// Path to scan
#[arg(default_value = ".")]
pub path: String,
/// Output format
#[arg(short, long, value_enum, default_value = "terminal")]
pub format: OutputFormat,
/// Minimum severity to report
#[arg(short, long, value_enum)]
pub severity: Option<SeverityFilter>,
/// Path to Semgrep YAML rule file or directory
#[arg(short, long)]
pub rules: Option<String>,
/// Disable built-in rules and run only external rules loaded via --rules
#[arg(long, default_value_t = false)]
pub no_builtins: bool,
/// Maximum file size in bytes to scan (default: 1 MB)
#[arg(long, default_value_t = 1_048_576)]
pub max_file_size: u64,
}
#[derive(Args, Debug, Clone)]
pub struct TuiArgs {
/// Path to scan
#[arg(default_value = ".")]
pub path: String,
/// Path to foxguard config file
#[arg(long)]
pub config: Option<String>,
/// Minimum severity to report
#[arg(short, long, value_enum)]
pub severity: Option<SeverityFilter>,
/// Path to Semgrep YAML rule file or directory
#[arg(short, long)]
pub rules: Option<String>,
/// Disable built-in rules and run only external rules loaded via --rules
#[arg(long, default_value_t = false)]
pub no_builtins: bool,
/// Scan changed files only (staged first, then unstaged)
#[arg(long, default_value_t = false)]
pub changed: bool,
/// Exclude scan-relative paths by glob or prefix (repeatable)
#[arg(long)]
pub exclude: Vec<String>,
/// Apply a baseline file to suppress known findings
#[arg(long)]
pub baseline: Option<String>,
/// Show only new findings compared to a target branch
#[arg(long, value_name = "TARGET", conflicts_with = "secrets")]
pub diff: Option<String>,
/// Scan repositories and changed files for common secrets
#[arg(long, default_value_t = false, conflicts_with = "diff")]
pub secrets: bool,
/// Show source-to-sink dataflow traces in the detail pane when available
#[arg(long, default_value_t = false)]
pub explain: bool,
/// Maximum file size in bytes to scan (default: 1 MB)
#[arg(long, default_value_t = 1_048_576)]
pub max_file_size: u64,
}
#[derive(Subcommand, Debug, Clone)]
pub enum Command {
/// Install a pre-commit hook for local foxguard runs
Init(InitArgs),
/// Generate a baseline file from current findings
Baseline(BaselineArgs),
/// Scan repositories and changed files for common secrets
Secrets(SecretsArgs),
/// Show only new findings compared to a target branch
Diff(DiffArgs),
/// Explore scan findings in the interactive terminal TUI
Tui(TuiArgs),
}
#[derive(Parser, Debug)]
#[command(
name = "foxguard",
about = "Fast local security guard for changed files, built-in rules, and Semgrep-compatible YAML",
version
)]
pub struct Cli {
#[command(subcommand)]
pub command: Option<Command>,
#[command(flatten)]
pub scan: ScanArgs,
}
impl SeverityFilter {
pub fn to_severity(&self) -> crate::Severity {
match self {
SeverityFilter::Low => crate::Severity::Low,
SeverityFilter::Medium => crate::Severity::Medium,
SeverityFilter::High => crate::Severity::High,
SeverityFilter::Critical => crate::Severity::Critical,
}
}
}