---
title: "How do I use the Luminesce CLI?"
slug: "how-do-i-use-the-luminesce-cli"
updated: 2025-02-18T16:46:10Z
published: 2025-02-18T16:46:10Z
canonical: "support.lusid.com/how-do-i-use-the-luminesce-cli"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.lusid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How do I use the Luminesce CLI?

The Luminesce CLI runs queries either:

- At the command line or from files, in which case results can be returned in CSV, Excel or SQLite formats.
- Using interactive mode, in which case results can be printed.

[See all tools and interfaces to Luminesce](/v1/docs/what-tools-are-available-to-write-luminesce-queries).

## Installing the CLI

1. Make sure your computer has .NET 8 installed.

> [!NOTE]
> **Note:** Version 1.17.X and below of the binaries requires .NET 6.
2. As a LUSID user with the `lusid-administrator` role, navigate to `<your-domain>.lusid.com/honeycomb/swagger/index.html`, where `<your-domain>` is the root of your LUSID domain, for example `acmecorp`. If you do not have the `lusid-administrator` role, [see the appendix](/v1/docs/how-do-i-use-the-luminesce-cli#appendix-a-allowing-nonadministrative-users-to-downloading-binaries).
3. Use Swagger's **Try it out** button for the `DownloadBinary` API to request the `CommandLineTool` binary: ![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/11a9caa4-893f-4469-bf04-60dc98386085.png)
4. Click the **Download file** link in the response to download the binary to your browser's download location: ![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/a462bf9c-0cc2-4119-a82f-7efb62e4b356.png)
5. Navigate to the download and run the following command, omitting the `.nupkg` file extension and, on Mac, using the x64 version of `dotnet`:

```bash
C:\Users\JohnDoe\Download> dotnet tool install Finbourne.Luminesce.Cli -g --add-source "."
```

Note that the CLI is installed in the following location:
  - Windows: `%USERPROFILE%\.dotnet\tools\.store\`
  - Linux/MacOS: `$HOME/.dotnet/tools/.store/`
6. Run the following command to start the service, omitting the `.exe` extension on Linux or MacOS:

```bash
C:\Users\JohnDoe\.dotnet\tools> luminesce-cli.exe --quiet --authClientDomain=<your-domain> --certificateFallback=DownloadMayMint
```

...where `&lt;your-domain&gt;` is the root of your LUSID domain, for example `--authClientDomain=acmecorp`. Note the `DownloadMayMint` option mints a new certificate if you do not have one already; more information on managing certificates is coming soon.

> **Note**: For information on all the command line options, run the command `luminesce-cli.exe --help`.

The CLI starts in interactive mode, so you can write a query like this and press `CTRL-ENTER` to run it:

![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/113ae51d-cf9b-4f76-a79c-3da2e640e7f1.png)

To uninstall the package, perhaps in order to upgrade to a newer version, run the command `dotnet tool uninstall Finbourne.Luminesce.Cli -g`.

## Appendix A: Allowing non-administrative users to downloading binaries

Once a license is granted, users with the `lusid-administrator` role have permission to download the `CommandLineTool` binary out-of-the-box.

To enable less privileged users to download, [create a feature policy](/v1/docs/how-do-i-create-a-feature-policy) consisting of the following JSON, assign it to a role, and the role to their LUSID user:

```json
{
    "description": "User can download CLI binary",
    "applications": [
        "Honeycomb"
    ],
    "grant": "Allow",
    "selectors": [
        {
            "idSelectorDefinition": {
                "identifier": {
                    "code": "CommandLineTool",
                    "scope": "Honeycomb"
                },
                "actions": [
                    {
                        "scope": "Honeycomb",
                        "activity": "DownloadBinary",
                        "entity": "Feature"
                    }
                ],
                "name": "Command line tool binary",
                "description": "User can download CLI binary"
            }
        }
    ],
    "when": {
        "activate": "2023-01-01T00:00:00.0000000+00:00",
        "deactivate": "9999-12-31T23:59:59.9999999+00:00"
    }
}
```