Skip to main content

CLI

The Foundation CLI provides command-line tools for working with foundation design and analysis data, including Excel integration for easy data import and processing.

Auth​

The authorisation CLI is accessed through the simplex auth command group:

simplex auth --help

Login​

Authenticates with your Simplex account using device flow and stores a time-limited access token locally. This enables you to use commands that require authentication.

simplex auth login

Logout​

Removes your local access token and ends the current session. After logout, commands that require authentication will ask you to log in again.

simplex auth logout

Who am I​

Shows your current authentication status and displays the stored access token if you are logged in.

simplex auth who-am-i

Foundation​

The foundation CLI is accessed through the simplex foundation command group:

simplex foundation --help

from-excel​

The from-excel command allows you to import foundation data from an Excel template spreadsheets and process them for analysis.

simplex foundation from-excel -i "foundation_data.xlsx" -o "out_project_out.json"
info

Download Excel Template

The template includes:

  • Pre-configured sheets (Foundations, Loads, Soil)
  • Correct column headers and formatting
  • Example data to guide your input
  • Data validation rules where applicable

Simply download the template, replace the example data with your project data, and use it with the from-excel command.