You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,9 @@ devcap scan --format json
36
36
# Markdown tables (paste into docs)
37
37
devcap scan --format markdown
38
38
39
+
# Public-safe metadata: suppress hostname and executable paths
40
+
devcap scan --format markdown --redact
41
+
39
42
# Scan only Python-related tools
40
43
devcap scan --profile python-dev
41
44
@@ -45,6 +48,9 @@ devcap check --profile devops
45
48
# Custom profile
46
49
devcap scan --config my-tools.toml
47
50
51
+
# Include project-local/vendor PATH entries such as node_modules/.bin or .venv/bin
52
+
devcap scan --profile node-dev --include-vendored
53
+
48
54
# List available profiles
49
55
devcap list-profiles
50
56
```
@@ -91,6 +97,8 @@ version_flag = "-v"
91
97
92
98
Tools listed in the registry inherit their detection config automatically. Custom tools need `binary` and optionally `version_flag`.
93
99
100
+
Custom profiles execute local binaries to collect versions. Treat profiles from third-party repositories like code, not passive data. By default, `devcap` rejects interpreter-style custom commands and skips vendored/project-local PATH entries such as `node_modules`, `.venv`, `venv`, `__pypackages__`, `.tox`, and `.nox`; use `--include-vendored` only when you trust the checkout being scanned.
101
+
94
102
## Output Formats
95
103
96
104
**Text** (default) — columnar, human-readable:
@@ -113,7 +121,7 @@ Tools listed in the registry inherit their detection config automatically. Custo
113
121
}
114
122
```
115
123
116
-
**Markdown** — tables for documentation or READMEs.
124
+
**Markdown** — tables for documentation or READMEs. Terminal control sequences and Markdown table delimiters from tool output are sanitized before display, but environment inventory can still reveal hostnames, paths, installed tools, and service status. Use `--redact` to replace hostname and executable paths before publishing output.
Copy file name to clipboardExpand all lines: SECURITY.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,12 @@ Instead, use one of these methods:
24
24
- Potential impact
25
25
- Suggested fix (if you have one)
26
26
27
+
## Local Scan Boundary
28
+
29
+
`devcap` is a local inventory tool. It executes discovered binaries with version flags, so custom profiles and PATH entries from untrusted repositories must be treated as executable inputs. The default scanner rejects high-risk custom interpreter commands, skips vendored/project-local PATH segments unless `--include-vendored` is set, validates custom profile schema, separates `systemctl` options from service names, and sanitizes terminal/Markdown display output.
30
+
31
+
Inventory output may include hostnames, OS details, executable paths, tool versions, and service state. Use `--redact` to suppress hostname and executable paths, then review JSON, text, and Markdown output before publishing it or uploading it as a public artifact.
0 commit comments