Set Up the Command Line Tool (v0)

Contents

Overview

This article introduces how to set up the Kintone Command Line Tool v0 (cli-kintone v0) for Windows and Mac users.

Attention

As of October 31st 2023, support for cli-kintone v0 has ended. For the latest features and security support it is highly recommended to upgrade to cli-kintone v1. For instructions to install cli-kintone v1, refer to the installation guide (External link) in GitHub.

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.

STEP 2: Launch the command prompt

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

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.

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

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.

STEP 2: Launch the terminal

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

STEP 3: Run the Command Line Tool

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

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.