Merge pull request #472 from immobiliare/feat/cli

Feat: CLI and binary build
immobiliare · Jan 30, 2023 · b4b228d · b4b228d
2 parents 1604704 + eeb6fec
commit b4b228d
Show file tree

Hide file tree

Showing 8 changed files with 2,113 additions and 337 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -24,7 +24,7 @@ jobs:
               run: npm i
 
             - name: Build
-              run: npm run build
+              run: npm run compile
 
             - name: Semantic release
               uses: codfish/semantic-release-action@v2

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.out
 # Logs
 logs
 *.log

diff --git a/.releaserc.json b/.releaserc.json
@@ -14,7 +14,22 @@
                 "assets": ["CHANGELOG.md", "package.json", "package-lock.json"]
             }
         ],
-        "@semantic-release/github",
+        [
+            "@semantic-release/github",
+            {
+                "assets": [
+                    {
+                        "path": ".out/dats-cli-linux",
+                        "label": "Linux distribution"
+                    },
+                    {
+                        "path": ".out/dats-cli-macos",
+                        "label": "Macos distribution"
+                    },
+                    { "path": ".out/dats-cli-win", "label": "Win distribution" }
+                ]
+            }
+        ],
         [
             "@saithodev/semantic-release-backmerge",
             {

diff --git a/README.md b/README.md
@@ -35,6 +35,8 @@ Supports Node.js `>=14.0.0`, if you are a Node.js `v12` user refer to `[email protected].
         -   [`Client.gauge(string, value)`](#clientgaugestring-value)
         -   [`Client.set(string, value)`](#clientsetstring-value)
 -   [Dats Mock](#dats-mock)
+-   [CLI Interface](#cli-interface)
+    -   [CLI Usage](#cli-usage)
 -   [Benchmarks](#benchmarks)
 -   [Powered Apps](#powered-apps)
 -   [Support & Contribute](#support--contribute)
@@ -240,6 +242,31 @@ console.log(client.metrics);
 */
 ```
 
+## CLI Interface
+
+dats is also exposed as a CLI that can both be installed as a npm global package or a precompiled binary.
+
+The precompile binary can be found in the [release section](https://github.com/immobiliare/dats/releases) for linux, macos or window.
+
+### CLI Usage
+
+```sh
+$ npm i -g @immobiliarelabs/dats
+dats --help
+# ℹ️  The following are required input flags:
+#
+#         --host {string} []
+#         --port {string} []
+#         --type {string} [Metric type can be one of: counter, timing, gauge, set]
+#         --prefix {string} [Metric prefix]
+#         --namespace {string} [Metric full namespace, use dots `.` to separate metrics]
+#         --value {string} [Metric value]
+#         --quiet {boolean} [Suppress all console output]
+#         --dryRun {boolean} [Metric wont be sent, use for debug]
+#
+# If unsure of output run the command prepended with `DRY_RUN=1`
+```
+
 ## Benchmarks
 
 The automatic benchmarking for every commit can be found at the following links: [next](https://immobiliare.github.io/dats/next/bench/index.html) and
-Original file line number
+Diff line change
@@ -1,3 +1,4 @@
+    .out
     # Logs
     logs
     *.log
@@ Expand Down @@