Preparing the Command Line Tool

Introduction

The Kintone Command Line Tool (a.k.a cli-kintone) is a tool that allows users to easily input and output data to and from Kintone through the command line. The Kintone Command Line Tool has been tested to run on Windows, Mac OS X, and Linux, and can be downloaded from Github.

This article will go through the very first steps for the Command Line Tool - how to get the Command Line Tool ready to run.

Preparing for Windows

STEP 1: Download the Tool

Download the Windows file from Github.
Extract the downloaded zip file and save cli-kintone.exe in any folder (e.g. Program Files) under the C drive.
cmd0.PNG

STEP 2: Launch the Command Prompt

On Windows, press Win+R on your keyboard to open the Run dialog box. 
cmd1.PNG


Enter cmd and click OK to open up the command prompt.

STEP 3: Run the Command Line Tool

Within the command prompt, move to the directory where the cli-kintone.exe file was saved using the cd command. Once the directory has been reached, type in "cli-kintone.exe" to list the available options for the Command Line Tool.
cmd2.PNG

If the list displays correctly, cli-kintone is now ready to be used on the Windows PC.
If the command prompt does not show the list, and states that it's not recognizing cli-kintone.exe, the file may not exist in the current directory. Use the ls command to list the files within the current directory to check if the file exists.

Preparing for Mac

STEP 1: Download the Tool

Download the MacOS file from Github.
Mac_1.png

Extract the downloaded zip file and save cli-kintone under /usr/local/bin. Use the mv command if needed to move cli-kintone to a different directory using the Terminal.
Mac_2.png

STEP 2: Launch the Terminal

Search for terminal in the Spotlight search to open up the terminal.
Mac_3.png

STEP 3: Run the Command Line Tool

Within the terminal, type in "cli-kintone" to list the available options for the Command Line Tool.
Mac_4.png


If the list displays correctly, cli-kintone is now ready to be used on the Mac.
If the terminal responds saying that the command could not be found, the PATH environment variables for the Mac may need to be edited to use cli-kintone.

Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!