メインコンテンツまでスキップ

インストール

このページは、cli-kintoneのインストールをサポートします。

npmjs.comから​

環境にNode.jsを設定している場合、npmを使用してcli-kintoneをインストールできます。 これは、プラグイン/カスタマイズ開発やCIでの使用に適しています。

以下のコマンドを実行します：

npm install @kintone/cli --global

または、ローカルにインストールする場合：

npm install @kintone/cli

npmパッケージの詳細については、@kintone/cliをご覧ください。

バイナリファイルから​

  1. Releasesページに移動します。
  2. 「Assets」から、お使いのプラットフォーム用のZIPファイルをダウンロードします。
    • Windows: cli-kintone_${version}_win.zip
    • Linux: cli-kintone_${version}_linux.zip
    • macOS: cli-kintone_${version}_macos.zip
  3. ダウンロードしたzipファイルを展開します
  4. 以下のように展開したファイルを実行して、コマンドが使用可能であることを確認します。
    • Windows: コマンドプロンプトでcli-kintone.exe
    • Linux & macOS: ターミナルで./cli-kintone

どこからでもcli-kintoneを実行する​

任意のディレクトリからcli-kintoneコマンドを実行するには、以下のいずれかを行います：

  • 絶対パスを指定してコマンドを実行する
  • PATH環境変数を設定する
  • cli-kintoneファイルを/usr/local/binディレクトリに移動する（Linux & macOS用）

コマンド補完​

cli-kintoneは、Tabキーを使用して部分的に入力されたコマンドを補完するコマンド補完機能を提供しています。

備考

cli-kintoneのコマンド補完は、現在bashとzshシェルでサポートされています。

zsh​

zshで有効にするには、cli-kintone実行ファイルが含まれるディレクトリにcdして、以下のコマンドを実行します：

# 1. PATH環境変数を設定
echo "export PATH=$(pwd):\$PATH" >> ~/.zshrc

# 2. 補完スクリプトを保存するディレクトリを作成して設定
mkdir -p ~/.zsh_completion.d/
echo 'fpath=(~/.zsh_completion.d $fpath)' >> ~/.zshrc

# 3. bash-autocomplete機能を有効化
echo 'autoload bashcompinit && bashcompinit' >> ~/.zshrc
echo 'autoload -Uz compinit && compinit' >> ~/.zshrc

# 4. コマンド補完スクリプトを作成
./cli-kintone completion >> ~/.zsh_completion.d/_cli-kintone

# 5. zshをリロード
source ~/.zshrc

bash​

bashで有効にするには、cli-kintone実行ファイルが含まれるディレクトリにcdして、以下のコマンドを実行します：

# 1. コマンド補完スクリプトを作成
mkdir -p ~/.bash_completion.d
./cli-kintone completion >> ~/.bash_completion.d/_cli-kintone

# 2. bashにコマンド補完スクリプトを追加

# ログインシェルの場合
echo "export PATH=$(pwd):\$PATH" >> ~/.bash_profile
echo 'source ~/.bash_completion.d/_cli-kintone' >> ~/.bash_profile
source ~/.bash_profile

# 非ログインシェルの場合
echo "export PATH=$(pwd):\$PATH" >> ~/.bashrc
echo 'source ~/.bash_completion.d/_cli-kintone' >> ~/.bashrc
source ~/.bashrc

Windows OSの場合​

Windows OSの場合、WSL2のbashを介してcli-kintoneのコマンド補完を使用できます。

手順：

  1. WSLでWindows上にLinuxをインストールします。参照：WSL2。
  2. 新しいLinuxターミナルを開きます。
  3. Linuxパッケージから実行ファイルをダウンロードして展開します。
  4. bashセクションと同じコマンドを実行します。