tccli - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

package.json

 {
   "name": "tccli",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "author": "J. Victor Soto",
@@ -27,3 +27,3 @@ "license": "MIT",
     "debug": "^2.6.8",
-    "tc-wrapper": "^1.0.6"
+    "tc-wrapper": "^1.0.7"
   },
@@ -30,0 +30,0 @@ "devDependencies": {

README.md

@@ -15,6 +15,26 @@ # tc-wrapper-cli
 
-The cli has three major commands ```del```, ```get``` and ```set```, for deleting, fetching and setting tc rules.
+### Help
+```sh
+  Usage: tccli <operation> <iface> [options]
 
-There is also an ```add``` command to make easier add more rules to existing ones, this command will running get, del and set under the hood as tc-wrapper lib dont support add.
+  Options:
 
+    -h, --help                  output usage information
+    -V, --version               output the version number
+    -d --direction [direction]  Rule traffic direction. Allowed outgoing or incoming.
+    -n --network [network]      Network including mask
+    --srcPort [port]            Destination port.
+    --dstPort [port]            Source port.
+    -p --protocol [protocol]    Protocol of rules. Only supported IPv4 right now.
+    --delay [time]              Delay including unit. Ex: 10ms
+    --jitter [time]             Delay variation including unit. Ex: 10ms
+    --loss [percentage]         Packet loss including unit. Ex: 5%
+    --corrupt [percentage]      Packet corruption including unit. Ex: 1%
+    --rate [bandwidth]          Bandwith limit including unit. Ex: 10Mbit
+```
+
+The cli has three major operations: ```del```, ```get``` and ```set```, for deleting, fetching and setting tc rules.
+
+There is also an ```add``` command to make easier add more rules to existing ones, this command will running get and set under the hood as tc-wrapper lib dont support add.
+
 **Allowed targeting**
@@ -111,2 +131,28 @@
 
+```sh
+tccli get eth0
+```
+
+```json
+{
+  "outgoing": {
+    "network=0.0.0.0/0,protocol=ip": {
+      "loss": "20%",
+      "rate": "100Mbit"
+    },
+    "network=192.168.1.1/32,protocol=ip": {
+      "corrupt": "2%",
+      "rate": "32Gbit"
+    }
+  },
+  "incoming": {
+    "network=10.10.10.0/28,srcPort=80,dstPort=80,protocol=ip": {
+      "corrupt": "2%",
+      "rate": "32Gbit"
+    }
+  }
+}
+
+```
+
 ## Enable debug of module
@@ -113,0 +159,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10923

increased by12.9%

Number of lines in readme file

179

increased by34.59%

Dependency changes

• Updatedtc-wrapper@^1.0.7