Kaizen #160: Automating ZDK CLI commands using shell scripting
Hello everyone,
Welcome back to Kaizen. ZDK CLI's command-line nature allows you to easily incorporate it within a shell script, to achieve any custom action that you want to execute. It allows you to execute multiple ZDK CLI commands seamlessly, enhancing productivity.
In this week's Kaizen post, we will discuss a shell script designed to automate the process of pushing locally modified metadata to our CRM environment. Before executing the push operation, ensure that the local metadata is up-to-date and conflicts (same file has been modified in both the local ZDK environment and the remote UI environment) are resolved. To achieve this, we will perform the following steps for files in conflict where manual intervention is required:
- Retrieve the latest metadata from Zoho CRM to our local environment using zdk org:pull command
- Address conflicts that may arise during the pull operation using zdk org:pull:resolve command
- Update our local directory with the newly pulled file using zdk org:pull:update command
- Push changes from your local environment to the CRM using zdk org:push command
- Update local directory and check status of push command using zdk org:push:result command
This script automates the sequential execution of these commands.
Prerequisites
- ZDK CLI Version 1.0.2-beta
To update ZDK CLI, execute the following command in your terminal
npm install -g @zohocrm/zdk-cli |
This will initiate the installation process for the latest version.
Crafting the Shell Script
1.Create a new shell script file zdk_automation.sh in your ZDK project's root directory.
#!/bin/bash touch stdout.txt #This script is used to automate ZDK CLI conflict resolve flow conflict_flag=false # Clear stdout.txt at the start > stdout.txt #Step 1: Initial Push Command echo "====Start of the script ====" >> stdout.txt echo "**Executing the initial zdk org:push -j" >> stdout.txt json_content=$(zdk org:push -j) echo "Output $json_content" >> stdout.txt next_command=$(echo "$json_content" | jq -r '.next_command_sequence // empty') echo "next_command after initial push is $next_command">> stdout.txt # Check if the JSON is valid if echo "$json_content" | jq empty 2>/dev/null; then #Step 2: Conflict Detection message=$(echo "$json_content" | jq -r '.message') echo "message: $message" >>stdout.txt if [[ "$message" == *"Merge Conflicts!"* ]]; then #Step 3: Resolving Conflicts conflict_flag=true # Pull changes to the local repository and store the output in a variable echo "**Executing zdk org:pull -j" >> stdout.txt json_content=$(zdk org:pull -j) echo "Output $json_content" >> stdout.txt if echo "$json_content" | jq empty 2>/dev/null; then message=$(echo "$json_content" | jq -r '.result') echo "message $message" >>stdout.txt IFS=$'\n' read -r -d '' -a filenames <<< "$message" # Iterate over each filename and execute the resolve command for filename in "${filenames[@]}"; do echo "**Executing zdk org:pull:resolve for $filename" >> stdout.txt # Executing zdk org:pull:resolve json_content=$(zdk org:pull:resolve -f "$filename" -j) echo "Output $json_content" >> stdout.txt done echo "***Executing zdk org:pull:update" >> stdout.txt json_content=$(zdk org:pull:update -j) echo "Output $json_content" >> stdout.txt fi fi fi #Step 4: Second Push Attempt after conflict if [ "$conflict_flag" = true ]; then # Push changes to the org and store the output in a variable again echo "***Executing: zdk org:push -j after conflict resolution" >> stdout.txt json_content=$(zdk org:push -j) echo "Output $json_content" >> stdout.txt # Extract the line containing "next_command_sequence" from the push output next_command=$(echo "$json_content" | jq -r '.next_command_sequence') echo "Next command $next_command " >> stdout.txt fi #Step 5: Push result command # Execute the next command if it exists counter=0 # Initialize a counter if [ -n "$next_command" ]; then while true; do # Execute the command stored in next_command and capture the output echo "***Executing: $next_command -j" >> stdout.txt output=$(eval "$next_command -j") echo "Output $output" >>stdout.txt # Check if the output contains "Process in progress" if echo "$output" | grep -q "Process in progress"; then echo "Push process in progress. Waiting for 5 seconds..." >> stdout.txt sleep 5 # Wait for 5 seconds else # If not found, break the loop and handle the output echo "Command executed successfully or completed." >> stdout.txt break fi # Increment the counter counter=$((counter + 1)) # Break the loop after 10 iterations if [ "$counter" -ge 10 ]; then echo "Maximum number of attempts(10) reached. Exiting the loop." >> stdout.txt echo "Try executing $next_command after some time" >> stdout.txt break fi done fi |
Explanation of the script
Step 1: Initial Push Command
- The script starts by executing the zdk org:push -j command.
- The commands executed using -j option ensures that the output is in a machine-readable JSON format, which facilitates easier parsing and processing.
- The conflict_flag is set to false.
Step 2: Conflict Detection
- The script checks the output for any merge conflicts.
- If conflicts are detected, it executes the zdk org:pull -j command to retrieve the latest changes from the organization. The conflict_flag is set to true.
- If conflicts are not present, the script proceeds to Step 5: Executing the push:result command.
Step 3: Resolving Conflicts
- If conflicts are present, the script extracts a list of filenames associated with these conflicts.
- It iterates through this list and executes the zdk org:pull:resolve -j command for each filename, allowing for manual resolution of conflicts as needed.
- This opens a three-way editor in the browser where the conflicts can be resolved.
Step 4: Second Push Attempt after conflict
- Once all conflicts are resolved, the script attempts to push any changes back to Zoho CRM by executing the zdk org:push -j command.
Step 5: Executing push:result command
- This command should be followed by zdk org:push:result --jobid {id} command (indicated by a next_command_sequence) which displays the result of the push process with the mentioned job id and updates the local directory.
- During this process, if the result is shown as "Process in progress", a subsequent push:result command is required. In this case, the script waits for five seconds before trying again to ensure that operations complete successfully.
2.Make the script executable
chmod +x zdk_automation.sh |
3.Run your script
./zdk_automation.sh & tail -f stdout.txt |
Logging Actions: All actions taken by the script are logged in stdout.txt. This serves as a record for later reference and troubleshooting.
Using ZDK CLI with shell script ensures that your ZDK CLI operations are automated daily, minimizing manual intervention while effectively managing conflicts.
For the current beta release, ZDK CLI is exclusively available for Sandbox environment and is not operational in Production environments.
We hope you found this post useful. We will meet you next week with another interesting topic!
If you have any questions, let us know in the comment section.
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Mable Mary M P
Sticky Posts
Kaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes areKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
This user is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details
Hello, Just signed up to ZOHO on a friend's recommendation. Got the TXT part (verified my domain), but whenever I try to add ANY user, I get the error: This user is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details I have emailed as well and writing here as well because when I searched, I saw many people faced the same issue and instead of email, they got a faster response here. My domain is: raisingreaderspk . com Hope this can be resolved. Thank youGetting Project Template List using the REST API
I am trying to confirm that I can use the REST API to create a project using a project template. The API documentation indicates this is possible by providing the Template ID, but it is not clear at all how to get a list of available Project TemplatesHow to display the CONTACT ID in the Contact page
Hi, I've seen this conversation below and it is exactly the same question I'm raising now, but unfortunately the last message is not solved https://help.zoho.com/portal/community/topic/show-contact-id-while-editing-contact-form I need to show the ContactId and I don't know how to do this. The last message included in the conversaton shows the way but not it is not completed. "I am sorry by default we do not have the option to show the record ID for the contacts in the field in a record. When youHow to change margins in templates
Hi, I'm new to Zoho Campaigns, and am trying to figure out how to adjust the margins within an email template. The default margins make the text go all the way to the edges of the page. Please advise.Create Canvas list view templates from images powered by Zia
Currently available for all paid editions of Zoho CRM in the US, EU, IN, JP & CN DCs. Designing a personalized CRM interface just got even easier. In today’s fast-evolving digital landscape, AI is transforming the way we work by automating complex tasksPainfully Slow Zoho mail
Since yesterday Zoho Mail seems to have starting functioning very slowly and having a few bugs. It's slow to open mails, slow to send, slow to change between email accounts. Sometimes clicking on a particular folder (eg Sent folder) stops working and"Wrong password or login" Problem to configure Zoho on MAIL App on my Macbook
Hi, I'm having problems to configure my e-mail on my MAIL App(Macbook pro). My e-mail is hari@trespontoum.net Actually was working perfectly, and still working on my Iphone. My MAIL App prompt me that my login or password is wrong. I tried to change 3"User already exist in your org"
Hello, I've just read a discussion about this issue, which didn't solve my problem. I'm trying to add the following emails: sales@kiss-my-boutique.co.uk returns@kiss-my-boutique.co.uk orders@kiss-my-boutique.co.uk I'm getting an error message each time I try and add them. None of them are primary or secondary emails and none of them have been created as users before. I know this as when I try and login and do 'forgot my password' all I get is an error message saying 'user invalid'. Please advise.Operation Not Permitted
Hi, I have problem in adding user after verifying the domain but it seems like error appeared which is "operation not permitted". For your information, I had delete other domain before did it.Email forwarding setup fails
I'm trying to set up email forwarding from my Zoho email to my gmail address. I followed the directions to set up email forwarding here: https://www.zoho.com/mail/help/email-forwarding.html. I did only steps 1-6. After doing this, rather than settingPassing the CRM
Hi, I am hoping someone can help. I have a zoho form that has a CRM lookup field. I was hoping to send this to my publicly to clients via a text message and the form then attaches the signed form back to the custom module. This work absolutely fine whenShopify store email issues- Not getting emails
Hi We have migrated from Microsoft outlook to Zoho back in March, we have a shopify store, the domain is hosted on namesilo, not shopify, I have seen some people here complaining about not getting emails from customers who fill out the contact form onHow do I fix this? Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked.
How do I fix this? Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked.Invoice Discount Account
Is there a way to change the account used for Discounts applied to an invoice? The current Discount account (ZB native account) type is an "Income" type. I would like to change it to "Other Income", but that is not possible, I am assuming because it containsNeed Inactive accounts to be visible in Reports in Zoho Books
I N=need Inactive accounts to be visible in Reports in Zoho Books to do recons of the accounts but when i see the same they are not visible in the Accountant - Account Transactions reportAPI Support for Creating Invoices with Batch-Tracked Items
Hi Zoho Community, I am working on an integration where we create invoices in ERPNext and push them to Zoho Books. I need to send batch-tracked items (batch numbers) when creating invoices. I could not find any reference in the Zoho Books API documentation.javax.mail.authenticationfailedexception 535 authentication failed
Hi, I am facing 535 authentication failed error when trying to send email from zoho desktop as well as in webmail. Can you suggest to fix this issue,. Regards, RekhaPhantom Opening Balance
While experimenting w/ creating a composite item, Zoho added funds to Petty Cash and added Bank Account equal to previous day's balance. I'm unable to undo the adding of funds. Attaching screenshots of both bank account and petty cash transactions.Importing customer comments and multiple shipto addresses
I am evaluating Zoho Books and have most of my data imported with two exceptions: (1) Import customer comments - in my current system I have several comments of different types, and I need to bring these into Zoho. Preferably Books customer records, butDetailed Account Reports - Add Running Balance
When one clicks into an account from a report (say P/L or Balance Sheet), the default reports have the Debit, Credit, and then the Amount. The Amount column (last one) is duplicate information. It would be far better and fit more peoples' use cases ifHow to Billed from two different GST Numbers
How to Billed from two different GST Numbers. Suppose ABC & Co had GST registration in Delhi and Haryana and Zoho account is created with Delhi GST Registration number. Now i also want to issue invoice from Haryana GST Registration number. How can i proceed ?Payment system for donations management
I manage an organization where we receive donations from payers. Hence, there is no need to first create invoices and then create payments received against the invoices. What are the recommended best practices to do this in ZohoBooks?Zoho IP blocked by SpamHaus
ERROR CODE :550 - 5.7.0 Your server IP address is in the SpamHaus SBL-XBL database, byeIMAP Communication Problems - IMAP Down Again
We are experiencing the same problems over the last week or so that were supposedly 'solved' according to this thread. Zoho Imap Down Again This is affecting attempts to use IMAP on multiple ISPs and users so is definitely narrowed down to Zoho problems.Can't login to Zoho mail
I'm logged into Zoho but when I try to go in zoho mail I get: Invalid request! The input passed is invalid or the URL is invoked without valid parameters. Please check your input and try again. I just set up my mx records and stuff with namecheap a fewHotmail is STILL blocking the zoho mail IP
Greetings, as I already mentioned in my last message, my Zoho IP has been blocked by Hotmail for more than 15 days. Although someone said that the issue was "solved," it still isn't, and this amount of time seems neither normal for a "serious" company,Keyboard shortcut M key
I'm trying to customize my keyboard shortcuts and assign the "m" key. But it says the key is already assigned. I've looked through all my shortcuts and can't see any assigned "m". When I select an email and press the M key, nothing happens. What is theManage customer access across multi-brand help centers
Hello everyone! Managing customer's access across multiple brands has been streamlined with the ability to invite, reinvite, approve, reject, and deactivate contacts individually for each help center brand . This enhancement gives administrators preciseWhite Label certificate
Hi all, About 72 hours ago, we fulfilled all steps for white labeling (CNAME to point to mail.cs.zohohost.eu), but since then the configuration page is now stuck at "generating certificate" since 3 days. When I execute an NSLOOKUP mail.webfoundry.be itUnusual activity detected from this IP. Please try again after some time
When i try to create new addresses on my account i am getting this error, it has been 24 hours now and i am still getting this error can anyone helpHow to add a new domain in my account?
Probably zoho has the worst UI in the market. Cannot add a new domain to manage a new email address.Ability for admin to access or make changes in zoho form without asking for ownership
Currently in zoho form only form owner can make the changes in the form and if someone else has to make changes then we have to transfer the ownership to them and even admin also cant access it . So i think admin must have the ability or option to accessWhy does Zoho’s diff viewer highlight parts of unchanged lines?
Hi everyone, I’ve noticed something odd in the Zoho editor’s diff view. When I delete a single line, the diff doesn’t just mark that line as removed. Instead, it highlights parts of the next line as if they changed, even though they are identical. Example:Report sorting not working
I make extensive use of Summary reports and Pivot Tables. Most of these reports are structured such that I have several columns of "information" data that I want displayed, followed by one or more "Data" summarizations. For example, I have the followingHow to convert MBOX to PDF
I have a my zoho mail data stored in MBOX format how can i convert it into PDF?New Enhancements in Wizards
Dear All, Wizards help you break a long form into a series of smaller forms on different screens, making it less overwhelming. We are thrilled to introduce a couple of enhancements to wizards in Zoho CRM: Enhancements for conditional rules in WizardsMicrosoft Teams now available as an online meeting provider
Hello everyone, We're pleased to announce that Zoho CRM now supports Microsoft Teams as an online meeting provider—alongside the other providers already available. Admins can enable Microsoft Teams directly from the Preferences tab under the MeetingsFind and Merge Duplicates to trigger webhook
My sales team uses the Find and Merge Duplicates feature often to cleanup records in the CRM. We use webhooks to signal to our internal tools database when new Contacts are created, updated, or deleted, in order to keep our DB in sync with Zoho CRM. However,Charting the 2025 Voyage: Zoho Invoice's Year in Review
2025 has been a year of progress, productivity, and purposeful growth for Zoho Invoice. From expanding into new regions to refining everyday workflows, each update was designed to help businesses stay compliant, get paid faster, and work with confidence.How to Hide System-DefinedTemplates in Service Report
Is there any option available to hide system-defined templates? these templates are causing confusion for field users.Next Page