Configuration

Configure the Ubidots CLI to connect with your account.

General syntax

ubidots <command> <subcommand> <argument> [options]

config

This command configures the CLI's cloud settings required to connect with your Ubidots account. This means that you must run this command prior to any other. It will prompt you for:

  • API domain: Leave the default value unless you are on a private Ubidots deployment.

  • Authentication method: The authentication method that you'd like to use.

  • Access token: A valid Ubidots tokenarrow-up-right.

ubidots config

API Domain [https://industrial.api.ubidots.com]:
Authentication Method [TOKEN]:
Access Token [*******************************pPem]:

> [DONE]: Configuration saved successfully.

This configuration will be saved at $HOME/.ubidots_cli/config.yaml. You can check it by running cat:

cat $HOME/.ubidots_cli/config.yaml

access_token: <ubidots-token>
api_domain: https://industrial.api.ubidots.com
auth_method: X-Auth-Token

Last updated

Was this helpful?