wanas-zcrm-extractor 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -5
- package/bin/cli.js +1 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://www.wanasapps.com">
|
|
3
|
+
<img src="https://www.wanasapps.com/WanasApps-logo.60b1ba4ed8605755.svg" alt="Wanas Apps Logo" width="320">
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
1
7
|
# Zoho CRM V8 Metadata Extractor (`zcrm`)
|
|
2
8
|
|
|
3
9
|
A robust, production-quality CLI utility and local web dashboard designed to authenticate with Zoho CRM (OAuth2 V8 APIs) and extract all metadata, settings, and Deluge scripts into a structured, developer-friendly local directory structure.
|
|
@@ -18,15 +24,33 @@ A robust, production-quality CLI utility and local web dashboard designed to aut
|
|
|
18
24
|
|
|
19
25
|
---
|
|
20
26
|
|
|
21
|
-
## 🛠️ Installation
|
|
27
|
+
## 🛠️ Installation & Usage Options
|
|
22
28
|
|
|
23
|
-
|
|
29
|
+
Because the `npm install` installation process runs non-interactively in the background, npm packages cannot prompt the user to choose between local or global scopes during the download. Instead, you can install the package using either of these two standard methods:
|
|
24
30
|
|
|
31
|
+
### Option A: Global Installation (Recommended for CLI tools)
|
|
32
|
+
Install the utility globally to execute the `zcrm` commands from any directory on your computer:
|
|
25
33
|
```bash
|
|
26
34
|
npm install -g wanas-zcrm-extractor
|
|
27
35
|
```
|
|
36
|
+
*Note: Depending on your system permissions, you may need to run this command as Administrator (Windows) or prefix it with `sudo` (macOS/Linux).*
|
|
37
|
+
|
|
38
|
+
Once installed, use the commands directly:
|
|
39
|
+
```bash
|
|
40
|
+
zcrm login
|
|
41
|
+
zcrm pull
|
|
42
|
+
```
|
|
28
43
|
|
|
29
|
-
|
|
44
|
+
### Option B: Local Installation
|
|
45
|
+
Install the utility inside a specific workspace directory as a project dependency:
|
|
46
|
+
```bash
|
|
47
|
+
npm install wanas-zcrm-extractor
|
|
48
|
+
```
|
|
49
|
+
Once installed, execute the commands using `npx` (which resolves the binary link inside your local `./node_modules/.bin` folder):
|
|
50
|
+
```bash
|
|
51
|
+
npx zcrm login
|
|
52
|
+
npx zcrm pull
|
|
53
|
+
```
|
|
30
54
|
|
|
31
55
|
---
|
|
32
56
|
|
|
@@ -181,6 +205,16 @@ metadata/
|
|
|
181
205
|
|
|
182
206
|
---
|
|
183
207
|
|
|
184
|
-
##
|
|
208
|
+
## 🏢 About Wanas Apps
|
|
209
|
+
|
|
210
|
+
**[Wanas Apps](https://www.wanasapps.com)** is an elite **Zoho Premium Partner** and consulting firm in the Middle East and North Africa (MENA) region. We specialize in digital transformation, Zoho implementation, custom CRM customization, full-stack application development on Zoho Catalyst, and building certified business compliance tools (such as Egyptian E-Invoice compliance integrations).
|
|
211
|
+
|
|
212
|
+
We start where off-the-shelf software ends, building custom features that fit around your business blueprint.
|
|
213
|
+
|
|
214
|
+
---
|
|
215
|
+
|
|
216
|
+
## ✉️ Support & Feedback
|
|
217
|
+
|
|
218
|
+
If you encounter any issues, have feature requests, or need custom Zoho integrations, please reach out to our team at **support@wanasapps.com**.
|
|
185
219
|
|
|
186
|
-
This project is maintained by Wanas Apps and licensed under the **ISC License**.
|
|
220
|
+
This project is maintained by Wanas Apps and licensed under the **ISC License**.
|
package/bin/cli.js
CHANGED
|
@@ -199,7 +199,7 @@ program
|
|
|
199
199
|
let clientId = options.clientId || DEFAULT_CLIENT_ID;
|
|
200
200
|
let clientSecret = options.clientSecret || DEFAULT_CLIENT_SECRET;
|
|
201
201
|
let dc = options.dc;
|
|
202
|
-
let redirectUri = options.redirectUri;
|
|
202
|
+
let redirectUri = options.redirectUri || 'http://localhost:3000/zoho/callback';
|
|
203
203
|
const refreshToken = options.refreshToken;
|
|
204
204
|
|
|
205
205
|
// Run interactive prompts if parameters are missing
|
|
@@ -213,19 +213,10 @@ program
|
|
|
213
213
|
default: 'com'
|
|
214
214
|
});
|
|
215
215
|
}
|
|
216
|
-
if (!redirectUri && !refreshToken) {
|
|
217
|
-
prompts.push({
|
|
218
|
-
type: 'input',
|
|
219
|
-
name: 'redirectUri',
|
|
220
|
-
message: 'Enter your Redirect URI:',
|
|
221
|
-
default: 'http://localhost:3000/zoho/callback'
|
|
222
|
-
});
|
|
223
|
-
}
|
|
224
216
|
|
|
225
217
|
if (prompts.length > 0) {
|
|
226
218
|
const answers = await inquirer.prompt(prompts);
|
|
227
219
|
dc = dc || answers.dc;
|
|
228
|
-
redirectUri = redirectUri || answers.redirectUri;
|
|
229
220
|
}
|
|
230
221
|
|
|
231
222
|
// 1. Headless flow using direct refresh token
|