Skip to content

Commit 8b18bbe

Browse files
authored
Merge branch 'main' into role_enum
2 parents 9c5386e + 44ef8d9 commit 8b18bbe

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,20 @@
33
<p align="center">
44
<img src="docs/contentctl_logo_white.png" title="In case you're wondering, it's a capybara" alt="contentctl logo" width="250" height="250"></p>
55

6-
7-
6+
# contentctl Quick Start Guide
7+
If you are already familiar with contentctl, the following common commands may be very useful for basic operations
8+
9+
| Operation | Command |
10+
|-----------|---------|
11+
| Create a repository | `contentctl init` |
12+
| Validate Your Content | `contentctl validate` |
13+
| Validate Your Content, performing MITRE Enrichments | `contentctl validate –-enrichments`|
14+
| Build Your App | `contentctl build` |
15+
| Test All the content in your app, pausing so that you can debug a search if it fails | `contentctl test –-post-test-behavior pause_on_failure mode:all` |
16+
| Test All the content in your app, pausing after every detection to allow debugging | `contentctl test –-post-test-behavior always_pause mode:all` |
17+
| Test 1 or more specified detections. If you are testing more than one detection, the paths are space-separated. You may also use shell-expanded regexes | `contentctl test –-post-test-behavior always_pause mode:selected --mode.files detections/endpoint/7zip_commandline_to_smb_share_path.yml detections/cloud/aws_multi_factor_authentication_disabled.yml detections/application/okta*` |
18+
| Diff your current branch with a target_branch and test detections that have been updated. Your current branch **must be DIFFERENT** than the target_branch | `contentctl test –-post-test-behavior always_pause mode:changes –-mode.target_branch develop` |
19+
| Perform Integration Testing of all content. Note that Enterprise Security MUST be listed as an app in your contentctl.yml folder, otherwise all tests will subsequently fail | `contentctl test –-enable-integration-testing --post-test-behavior never_pause mode:all` |
820

921
# Introduction
1022
#### Security Is Hard

0 commit comments

Comments
 (0)