Install the Command Line Tool
Overview
This article introduces how to install and set up the environment for
cli-kintone
. This tool helps developers import/export records to/from Kintone.
Installation
With Node.js
Node.js is needed to run the installation.
Once node.js is installed, cli-kintone can be installed using npm.
-
Download the installer from the Node.js Official Site:
Node.js.
-
Run the installer and follow the instructions.
-
After Node.js is successfully installed, run the following command:
1
npm install @kintone/cli --global
or to install locally:
1
npm install @kintone/cli
From Binary File
Download the cli-kintone executable
The cli-kintone executable can be downloaded via GitHub for Windows / macOS / Linux.
- Access
GitHub Releases
- From the Assets section, download one of the following:
- Windows:
cli-kintone-win.zip
- Linux:
cli-kintone-linux.zip
- macOS:
cli-kintone-macos.zip
- Windows:
- Unzip the file, and place the contents in a directory of your choosing
Run via the command prompt (for Windows users)
Use the command prompt to run cli-kintone. Open the command prompt via the following steps.
-
While holding the Windows key, press the R key. A prompt asking which program to run will appear.
-
In the name field, enter "cmd" and click OK. The command prompt will open.
-
Using the
cd
command, navigate to the folder containing the cli-kintone.exe file1 2
# Changing the directory to where the cli-kintone.exe files is located cd C:\Users\Desktop\works
Check the version
Check the version of cli-kintone with the following command.
|
|
For those using macOS, before executing the "cli-kintone" command, it is necessary to set the path.
In the bash_profile
, add the path of the directory where "cli-kintone" is stored.