@lynkwell/lynkwell-cli

lynkwell-cli

A CLI tool that enables complex actions within Lynkwell EV Charging APIs.

Installation

npm install -g @lynkwell/lynkwell-cli

Usage

In order to use the CLI, you must first set up an API client in the Lynkwell EV Charging Portal. Once you have an API client, you can authenticate with the CLI using one of the following ways:

Authenticating via Credentials File

If you performing multiple commands or are using the CLI on a regular basis, the fastest way to authenticate is to store your ID and secret key in a credentials file. The CLI will automatically look for a credentials file in your home directory at ~/.lynkwell/credentials. This file should take the following format:

[credentials]
clientId = "{YOUR CLIENT ID}"
clientSecret = "{YOUR CLIENT ID}"

You can easily create this file by using the configure command:

lw configure

Passing Credentials as Arguments

If you are only performing a single command, you can pass your credentials as arguments to the command. This is not recommended for regular use, as it will expose your credentials in your shell history.

lw change-configuration --clientId {Your Client ID} --clientSecret {Your Client Secret}

Actions

Bulk Retrieve Charging Station Manufacturing Info

lw get-manufacturing-info --help

Bulk Retrieve Charging Station Configurations

lw get-configuration --help

Bulk Change Charging Station Configurations

lw change-configuration --help