Merge branch 'develop' into Invitation-schema

keyshade-xyz · Jan 9, 2025 · 591921e · 591921e
2 parents 4b7452e + 2ed31c0
commit 591921e
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 5 deletions.
diff --git a/apps/cli/package.json b/apps/cli/package.json
@@ -15,8 +15,8 @@
   "type": "module",
   "scripts": {
     "build": "esbuild src/index.ts --bundle --platform=node --outfile=dist/index.esm.js --format=esm --banner:js='#!/usr/bin/env node' && esbuild src/index.ts --bundle --platform=node --outfile=dist/index.cjs --format=cjs --banner:js='#!/usr/bin/env node'",
-    "start": "node dist/index.js",
-    "dev": "pnpm build && node dist/index.js",
+    "start": "node dist/index.cjs",
+    "dev": "pnpm build && node dist/index.cjs",
     "lint": "eslint \"src/**/*.ts\" --fix",
     "publish": "pnpm build && pnpm publish --access public --provenance"
   },

diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -6,12 +6,12 @@
 
 - [Introduction](cli/introduction.md)
 - [Profile](cli/profile.md)
+- [Init](cli/init.md)
+- [Workspace](cli/workspace.md)
 - [Project](cli/project.md)
 - [Environment](cli/environment.md)
-- [Workspace](cli/workspace.md)
-- [Scan](cli/scan.md)
-- [Init](cli/init.md)
 - [Run](cli/run.md)
+- [Scan](cli/scan.md)
 
 ## 🥰 CONTRIBUTING TO KEYSHADE
 

diff --git a/docs/cli/introduction.md b/docs/cli/introduction.md
@@ -14,6 +14,20 @@ The CLI has the following commands:
 - [init](./init.md): This command is used to initialize your project to tap into the live updates from our platform.
 - [run](./run.md): This command is used to run your application.
 
+## Installing the CLI
+
+To install the CLI, simply run:
+
+```bash
+npm install -g @keyshade/cli
+```
+
+Verify the installation using:
+
+```bash
+keyshade --help
+```
+
 ## Global flags
 
 Global flags work with any command in the CLI. The following are the global flags: