CLI

This is the command line interface (CLI) for interacting with Soluble Fusion.

It can be used locally to run assessments and manage your account.

It is used in your CI environment to run assessments and report the results to Soluble Fusion.

Installation

Mac OS

The easiest way to install the CLI for MacOS is to use homebrew:

brew install soluble-ai/soluble/soluble-cli

To upgrade to the latest version:

brew upgrade soluble-ai/soluble/soluble-cli

Note: Due to Apple's notarization requirements, the brew installation builds the CLI from source. If this is a problem, you can download a precompiled binary from the GitHub Release page. However, you will have to approve it in Apple Preferences. We are working on distributing an Apple-notarized executable.

Linux

On Linux, run:

curl https://raw.githubusercontent.com/soluble-ai/soluble-cli/master/linux-install.sh | sh

This will install the latest version in the current directory. You will need to move it to an appropriate location on your PATH.

Precompiled binaries are also available on the Github Release page.

Windows

Precompiled binaries are available on GitHub Release page. Please note that our testing on Windows is minimal. Please file a GitHub issue if your run into any problems.

Build From Source

It's possible to build from source. Assuming you have go installed:

git checkout https://github.com/soluble-ai/soluble-cli.git
./hack/build.sh
./soluble version

CLI Authentication

Integrated Authentication

The CLI uses an OAuth flow with your browser to generate an authentication token and configuration.

$ soluble login

This will open a browser window and walk you through the authentication flow.

If you are running the CLI in an environment that does not have access to a browser (i.e. in SSH or interactive container sesssion) you run the auth process in headless mode, with:

$ soluble login --headless

This will give you a link to copy/paste into your browser. When you have completed the authentication flow, you will copy/paste the authentication code back to the CLI to complete the authentication flow.

Manually Obtianing Access Token

If you run into problems with the procedure above, you can obtian an access token manaully.

Log in to the UI and go to Access Tokens.

Generate an access token and then run:

$ soluble auth set-access-token --access-token <your-access-token>