Set Up the Command Line Tool

Contents

Overview

The Kintone Command Line Tool (External link) (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 (External link).

This article guides the user in setting up the Command Line Tool.

Set Up for Windows

STEP 1: Download the tool

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

Screenshot: A user saving the executable file in Windows.

STEP 2: Launch the command prompt

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

Screenshot: The Run dialog box on Windows.

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.

Screenshot: The execution options for cli-kintone.exe shown in the Windows command prompt.

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 is 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.

Set Up for Mac

STEP 1: Download the tool

Download the Mac OS X file from GitHub (External link).

Screenshot: A user saving the executable file in Mac OS X.

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.

Screenshot: The file shown in the /usr/local/bin directory.

STEP 2: Launch the terminal

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

Screenshot: A user opening the terminal application on Mac OS X.

STEP 3: Run the Command Line Tool

Within the terminal, type in “cli-kintone” to list the available options for the Command Line Tool.

Screenshot: A user running the cli-kintone command in the Mac OS X terminal.

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