securewithtrace 0.9.0 → 0.11.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 +81 -6
  2. package/dist/index.js +911 -167
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -10,7 +10,7 @@
10
10
 
11
11
  `tracecli` is the official CLI for Trace.
12
12
 
13
- Use it to authenticate, browse connected repositories, clone repositories, and inspect vulnerabilities directly from the command line.
13
+ Use it to authenticate, browse and filter connected repositories, clone repositories, and inspect vulnerabilities directly from the command line.
14
14
 
15
15
  ## Install
16
16
 
@@ -42,6 +42,9 @@ tracecli auth status
42
42
  # 3) List connected repositories
43
43
  tracecli repo list
44
44
 
45
+ # 3b) Filter repositories
46
+ tracecli repo list --platform GITHUB --status CONNECTED --query trace
47
+
45
48
  # 4) View vulnerabilities
46
49
  tracecli vulnerabilities list --severity HIGH
47
50
  ```
@@ -49,10 +52,10 @@ tracecli vulnerabilities list --severity HIGH
49
52
  ## What You Can Do
50
53
 
51
54
  - **Authenticate securely** with device authorization flow (`auth login/logout/status`)
52
- - **List repositories** connected to your Trace organization (`repo list`)
55
+ - **List and filter repositories** connected to your Trace organization (`repo list`, `repo filter`)
53
56
  - **Clone repositories** with secure token handling (`repo clone`)
54
57
  - **Filter vulnerabilities** by repo, severity, and status (`vulnerabilities list`)
55
- - **Export results as JSON** for automation (`vulnerabilities list --json`)
58
+ - **Export results as JSON or TSV** for automation (`vulnerabilities list --output json`)
56
59
 
57
60
  ## Command Reference
58
61
 
@@ -70,6 +73,15 @@ tracecli auth logout
70
73
  # List org repositories known to Trace
71
74
  tracecli repo list
72
75
 
76
+ # List only connected GitHub repositories that match "trace"
77
+ tracecli repo list --platform GITHUB --status CONNECTED --query trace
78
+
79
+ # Advanced filtering syntax (repeatable)
80
+ tracecli repo list --filter "platform=GITHUB" --filter "repo:trace" --filter "status!=DISCONNECTED"
81
+
82
+ # Alias command for filtering
83
+ tracecli repo filter --filter "language:typescript" --filter "branch=main"
84
+
73
85
  # Clone by owner/repo shorthand
74
86
  tracecli repo clone securewithtrace/trace
75
87
 
@@ -80,7 +92,7 @@ tracecli repo clone securewithtrace/trace --branch main --depth 1
80
92
  ### Vulnerabilities
81
93
 
82
94
  ```bash
83
- # List vulnerabilities across your organization
95
+ # List vulnerabilities across your organization (default: 30 results)
84
96
  tracecli vulnerabilities list
85
97
 
86
98
  # Filter by repository
@@ -89,15 +101,78 @@ tracecli vulnerabilities list --repo securewithtrace/trace
89
101
  # Filter by severity and status
90
102
  tracecli vulnerabilities list --severity CRITICAL --status OPEN
91
103
 
92
- # Machine-readable output
93
- tracecli vulnerabilities list --json
104
+ # Increase result limit
105
+ tracecli vulnerabilities list --limit 100
106
+
107
+ # JSON output for scripting
108
+ tracecli vulnerabilities list --output json | jq '.[].title'
109
+
110
+ # TSV output for awk/cut
111
+ tracecli vulnerabilities list --output tsv | cut -f1,7
94
112
  ```
95
113
 
114
+ Flags:
115
+
116
+ | Flag | Shorthand | Description |
117
+ |------|-----------|-------------|
118
+ | `--repo <repo>` | | Filter by repository name or `owner/repo` |
119
+ | `--severity <level>` | | Filter by severity |
120
+ | `--status <status>` | | Filter by status |
121
+ | `--limit <n>` | `-L` | Max results (default: 30, max: 100) |
122
+ | `--output <format>` | `-o` | Output format: `table` (default), `json`, `tsv` |
123
+
96
124
  Supported filter values:
97
125
 
98
126
  - `--severity`: `CRITICAL`, `HIGH`, `MEDIUM`, `LOW`
99
127
  - `--status`: `OPEN`, `IN_PROGRESS`, `FIXED`, `IGNORED`, `FALSE_POSITIVE`
100
128
 
129
+ Repository filter options:
130
+
131
+ - `--platform`: `GITHUB`, `GITLAB`, `BITBUCKET`
132
+ - `--status`: `CONNECTED`, `DISCONNECTED`
133
+ - `--query`: case-insensitive contains match across URL, repo name, default branch, and language
134
+ - `--default-branch`: case-insensitive contains match for default branch
135
+ - `--language`: case-insensitive contains match for primary language
136
+ - `--filter`: repeatable advanced expression in the form `<field><operator><value>`
137
+ - Supported fields: `platform`, `status`, `url`, `repo`, `branch`, `language`
138
+ - Supported operators: `=` (exact), `!=` (not exact), `:` (contains), `!:` (not contains)
139
+
140
+ ### Pentests
141
+
142
+ ```bash
143
+ # List pentests for your organization
144
+ tracecli pentest list
145
+
146
+ # Increase result limit
147
+ tracecli pentest list --limit 50
148
+
149
+ # JSON output for scripting
150
+ tracecli pentest list --output json | jq '.[].title'
151
+
152
+ # List findings for a pentest
153
+ tracecli pentest findings list --pentest PT-3
154
+
155
+ # Findings as JSON
156
+ tracecli pentest findings list --pentest PT-3 --output json
157
+
158
+ # Findings as TSV
159
+ tracecli pentest findings list --pentest PT-3 --output tsv | cut -f1,4
160
+ ```
161
+
162
+ Flags for `pentest list`:
163
+
164
+ | Flag | Shorthand | Description |
165
+ |------|-----------|-------------|
166
+ | `--limit <n>` | `-L` | Max results (default: 30, max: 100) |
167
+ | `--output <format>` | `-o` | Output format: `table` (default), `json`, `tsv` |
168
+
169
+ Flags for `pentest findings list`:
170
+
171
+ | Flag | Shorthand | Description |
172
+ |------|-----------|-------------|
173
+ | `--pentest <id>` | | Pentest display ID (e.g. `PT-3`) or UUID (required) |
174
+ | `--output <format>` | `-o` | Output format: `table` (default), `json`, `tsv` |
175
+
101
176
  ## Security Notes
102
177
 
103
178
  - Access tokens are stored at `~/.trace/token`.