lusidtools CLI

lusidtools Command Line Interface

lusidtools (lusid-python-tools) is a toolbox of basic commands for interacting with LUSID.

Installing lusidtools CLI

The lusidtools CLI is installed during the setup of the lusidtools python package. This can be installed with the following command.

pip install lusidtools

After the installation is complete and one of the three authentication methods below has been setup, run the following command to display tools available from the lusidtools CLI.

lusidtools --help

lusidtools CLI Authentication

Lusidtools commands can be authenticate using 3 methods:

1. a secrets.json file containing credentials
2. Credentials set as environment variables
3. Authenticated token

for more details on how to create a secrets.json file, setting environment variables or aquiring an authenticated token, see our support page on Authentication.

Authentication using a secrets file

Firstly, the lusditools CLI will look for a secrets.json file containing credentials in the current folder from which the lusidtools call was made. Alternatively the path to a secrets.json file can be explicitly stated using the --secrets-file argument on any lusidtools call.

Credentials set as environment variables

If no secrets.json file can be found, then the lusditools CLI checks for credentials set as environment variables. See the Using Environment Variables section of Getting started with the LUSID API and SDKs for details on setting these.

Authenticated token

If no credentials are found either in a secrets.json or set as environment variables, then the user will be prompted to provide the client name and an authenticated token. See the Authenticating & Generating an Access Token section of Getting started with the LUSID API and SDKs for details on how to get an Authenticated token. Note that these tokens are reset after a limited amount of time.

Managing transaction type configuration using lusidtools

The lusidtools CLI has a txn_cfg feature which you can use view and edit transaction type configurations.

some blue text