securewithtrace 0.8.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +56 -5
  2. package/dist/index.js +1537 -211
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -6,7 +6,6 @@
6
6
 
7
7
  <p align="center">
8
8
  <a href="https://www.npmjs.com/package/securewithtrace"><img alt="npm version" src="https://img.shields.io/npm/v/securewithtrace?color=0ea5e9&label=npm"></a>
9
- <a href="https://github.com/securewithtrace/trace/actions"><img alt="build status" src="https://img.shields.io/github/actions/workflow/status/securewithtrace/trace/release-please.yml?branch=main&label=release"></a>
10
9
  </p>
11
10
 
12
11
  `tracecli` is the official CLI for Trace.
@@ -53,7 +52,7 @@ tracecli vulnerabilities list --severity HIGH
53
52
  - **List repositories** connected to your Trace organization (`repo list`)
54
53
  - **Clone repositories** with secure token handling (`repo clone`)
55
54
  - **Filter vulnerabilities** by repo, severity, and status (`vulnerabilities list`)
56
- - **Export results as JSON** for automation (`vulnerabilities list --json`)
55
+ - **Export results as JSON or TSV** for automation (`vulnerabilities list --output json`)
57
56
 
58
57
  ## Command Reference
59
58
 
@@ -81,7 +80,7 @@ tracecli repo clone securewithtrace/trace --branch main --depth 1
81
80
  ### Vulnerabilities
82
81
 
83
82
  ```bash
84
- # List vulnerabilities across your organization
83
+ # List vulnerabilities across your organization (default: 30 results)
85
84
  tracecli vulnerabilities list
86
85
 
87
86
  # Filter by repository
@@ -90,15 +89,67 @@ tracecli vulnerabilities list --repo securewithtrace/trace
90
89
  # Filter by severity and status
91
90
  tracecli vulnerabilities list --severity CRITICAL --status OPEN
92
91
 
93
- # Machine-readable output
94
- tracecli vulnerabilities list --json
92
+ # Increase result limit
93
+ tracecli vulnerabilities list --limit 100
94
+
95
+ # JSON output for scripting
96
+ tracecli vulnerabilities list --output json | jq '.[].title'
97
+
98
+ # TSV output for awk/cut
99
+ tracecli vulnerabilities list --output tsv | cut -f1,7
95
100
  ```
96
101
 
102
+ Flags:
103
+
104
+ | Flag | Shorthand | Description |
105
+ |------|-----------|-------------|
106
+ | `--repo <repo>` | | Filter by repository name or `owner/repo` |
107
+ | `--severity <level>` | | Filter by severity |
108
+ | `--status <status>` | | Filter by status |
109
+ | `--limit <n>` | `-L` | Max results (default: 30, max: 100) |
110
+ | `--output <format>` | `-o` | Output format: `table` (default), `json`, `tsv` |
111
+
97
112
  Supported filter values:
98
113
 
99
114
  - `--severity`: `CRITICAL`, `HIGH`, `MEDIUM`, `LOW`
100
115
  - `--status`: `OPEN`, `IN_PROGRESS`, `FIXED`, `IGNORED`, `FALSE_POSITIVE`
101
116
 
117
+ ### Pentests
118
+
119
+ ```bash
120
+ # List pentests for your organization
121
+ tracecli pentest list
122
+
123
+ # Increase result limit
124
+ tracecli pentest list --limit 50
125
+
126
+ # JSON output for scripting
127
+ tracecli pentest list --output json | jq '.[].title'
128
+
129
+ # List findings for a pentest
130
+ tracecli pentest findings list --pentest PT-3
131
+
132
+ # Findings as JSON
133
+ tracecli pentest findings list --pentest PT-3 --output json
134
+
135
+ # Findings as TSV
136
+ tracecli pentest findings list --pentest PT-3 --output tsv | cut -f1,4
137
+ ```
138
+
139
+ Flags for `pentest list`:
140
+
141
+ | Flag | Shorthand | Description |
142
+ |------|-----------|-------------|
143
+ | `--limit <n>` | `-L` | Max results (default: 30, max: 100) |
144
+ | `--output <format>` | `-o` | Output format: `table` (default), `json`, `tsv` |
145
+
146
+ Flags for `pentest findings list`:
147
+
148
+ | Flag | Shorthand | Description |
149
+ |------|-----------|-------------|
150
+ | `--pentest <id>` | | Pentest display ID (e.g. `PT-3`) or UUID (required) |
151
+ | `--output <format>` | `-o` | Output format: `table` (default), `json`, `tsv` |
152
+
102
153
  ## Security Notes
103
154
 
104
155
  - Access tokens are stored at `~/.trace/token`.