Skip to main content

Options

This page introduces common options of cli-kintone.

info

Some options use environment variables as default values.

General

OptionDescription
--versionShow version number
--helpShow help

Logging

See Logging reference for more details.

OptionDescription
--log-levelChange log config level
Levels: debug, info, warn, error, fatal, none
--verboseSet log config level to debug

Authentication

OptionDescription
--base-urlKintone Base URL
Default to KINTONE_BASE_URL
--username, -uKintone Username
Default to KINTONE_USERNAME
--password, -pKintone Password
Default to KINTONE_PASSWORD
--api-tokenApp's API tokens
Default to KINTONE_API_TOKEN
--basic-auth-usernameKintone Basic Auth Username
Default to KINTONE_BASIC_AUTH_USERNAME
--basic-auth-passwordKintone Basic Auth Password
Default to KINTONE_BASIC_AUTH_PASSWORD
--pfx-file-pathThe path to the client certificate file
--pfx-file-passwordThe password of the client certificate file

Network

OptionDescription
--proxyThe URL of a proxy server
Format: http://username:password@host:port
Default to HTTPS_PROXY
See Proxy reference for more details.

Guest space

OptionDescription
--guest-space-idThe ID of guest space
Default to KINTONE_GUEST_SPACE_ID