@take2identity/verosint 0.2.200 → 0.2.201

package/README.md

@@ -93,7 +93,7 @@ verosint evaluate rules-batch --help
 
 The tool can read settings from a configuration file in a
 [YAML](https://yaml.org/) format.
-For example, you can store the API key as well as rule sets inside the file.
+For example, you can store the API key inside the file.
 
 By default, the tool looks for the configuration file `.verosint.yaml` in
 your home directory. You can override this setting with the
@@ -103,12 +103,6 @@ An example configuration file:
 
 ```yaml
 apiKey: <API key goes here>
-rules:
-    - name: IP - Tor/Bot/VPN
-      outcomes:
-        - DENY
-      query: 'signals.ip.bot || signals.ip.tor || signals.ip.vpn'
-      reason: This IP address is a known bot, active Tor node, or a VPN
 ```
 
 #### API key as an Environment Variable
@@ -118,7 +112,7 @@ of the API key:
 
 ```shell
 export VEROSINT_APIKEY="API key goes here"
-verosint evaluate evaluate rule phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
+verosint evaluate rules phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
 ```
 
 #### Account IDs
@@ -158,11 +152,11 @@ Responses are provided in the JSON format on the standard output.
 ###### 2. Evaluate an IPv6 address, a phone number and an email address for a Rule Set
 
 ```shell
-verosint evalute rule ip:2607:fb91:1296:c7dc:a0c4:25a9:ac7a:4384 email:user@example.com phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
+verosint evaluate rules ip:2607:fb91:1296:c7dc:a0c4:25a9:ac7a:4384 email:user@example.com phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
 
 ```
 
-###### 3. Evaluate an IPv4 for address against a rule set already defined in the configuration
+###### 3. Evaluate an IPv4 address against a rule set
 
 To obtain the UUID of the rule set, visit the
 [Rule Sets](https://app.verosint.com/rule-sets) configuration and copy the UUID of
@@ -171,45 +165,7 @@ the rule set you would like to evaluate.
 ![Copy Rule Set UUID](assets/copyrulesetuuid.png)
 
 ```shell
-verosint evalute rule ip:104.255.6.45 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
-```
-
-###### 4. Evaluate an Email address against a rule set provided using a local file
-
-You can export a rule set defined in the [Rule Sets](https://app.verosint.com/rule-sets)
-configuration into a local file as shown below.
-
-![Export Rule Set](assets/exportruleset.png)
-
-This example evaluates the `babs@jensen.com` email address against the rule defined
-in the `mfaruleset.json` file.
-
-```shell
-verosint evaluate rule email:babs@jensen.com --ruleSetFile mfaruleset.json
-```
-
-##### 5. Check if an IP address is within 100 kilometers of Austin, TX using a local rule set
-
-You can place a rule set inside a local configuration file. The following is
-an example file that uses the `isWithin` function, which enables you to
-create a rule set for [geo-fencing](https://en.wikipedia.org/wiki/Geo-fence)
-purposes:
-
-```yaml
-apiKey: <API key goes here>
-rules:
-    - name: IP not in Austin
-      outcomes:
-        - DENY
-      query: '!signals.ip.geo.isWithin(30.3079827, -97.895826, 100)'
-      reason: This IP is not within 100 kilometers of Austin, Texas
-```
-
-The following example runs the same rule set saved in the default
-configuration file against the `104.16.44.99` IP address:
-
-```shell
-verosint evaluate rules ip:104.16.44.99
+verosint evaluate rules ip:104.255.6.45 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
 ```
 
 #### Batch Evaluation
@@ -235,12 +191,12 @@ ipaddress,mail,telephone
 104.16.44.99,babs@jensen.com,15123944240
 ```
 
-Using the rule sets present in the default configuration file, the
-following command generates LDIF-formatted output and JSON report
-files:
+The following command evaluates the identifiers against a rule set and
+generates LDIF-formatted output and JSON report files:
 
 ```shell
 verosint evaluate rules-batch ip:0 email:1 phone:2 \
+  --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567 \
   --inputFile mapped.csv \
   --outputFile output.ldif --outputType ldif \
   --reportFile report.json

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@take2identity/verosint",
-  "version": "0.2.200",
+  "version": "0.2.201",
   "description": "Official CLI to interact with Verosint API",
   "main": "index.js",
   "scripts": {