ScalePadPlatform
All recipes
Appcliscalepadnpmautomationtypescriptquotercontrolmap

ScalePad CLI

Official CLI for the ScalePad Core, Lifecycle Manager, Quoter, and ControlMap APIs.

These recipes are starting points. Adapt and test them for your own environment.

The ScalePad CLI provides direct terminal access to the ScalePad Core, Lifecycle Manager, Quoter, and ControlMap APIs. It supports structured output formats (JSON, JSONL, CSV, Table), advanced filtering and sorting, multi-profile credential management, and mutation commands with file-body support.

Installation

Install the CLI globally via npm:

npm install -g @scalepad/cli

Quick Start

scalepad auth login
scalepad auth whoami
scalepad core clients list --limit 5
scalepad lm action-items list --limit 5
scalepad quoter quotes list --json
scalepad controlmap health list --json

The CLI resolves credentials in this order: --api-key flag → SCALEPAD_API_KEY env var → stored profile credential. When keychain access is available, credentials are stored with keytar; otherwise a local credential file with locked permissions is used.

API Coverage

Core — clients, contacts, contracts, hardware assets, SaaS assets, SaaS users, integrations, members, opportunities, service contracts, service tickets.

Lifecycle Manager (lm) — action items, assessments, assessment templates, contracts, goals, initiatives, meetings, meeting types, notes, hardware lifecycles.

Quoter — categories, items, item groups, item options, item tiers, manufacturers, suppliers, datafeeds, quotes, quote templates, line items.

ControlMap — health checks, risks, evidences, evidence requests, evidence mappings, documents, action items.

Output & Filtering Options

# Output formats
--json | --jsonl | --csv | --table

# Field projection
--fields id,name,num_contacts

# Filtering and sorting
--filter "type=eq:WORKSTATION"
--sort name --desc

# Pagination
--limit <count> --cursor <cursor> --all

Mutation Commands

# Inline JSON body
scalepad lm action-items update 12345 --body '{"status":"complete"}' --yes

# Body from file
scalepad lm action-items update 12345 --body-file ./payload.json --yes

# File upload (multipart)
scalepad controlmap evidence-requests documents create client-123 req-456 \
  --form file=@./artifacts/policy.pdf --yes --json

Example: Export all clients to CSV

scalepad core clients list \
  --profile work \
  --all \
  --csv \
  --fields id,name,num_contacts,num_hardware_assets

Example: Filter hardware assets

scalepad core hardware-assets list \
  --filter "type=eq:WORKSTATION" \
  --sort name \
  --table

Run scalepad core --help, scalepad lm --help, scalepad quoter --help, or scalepad controlmap --help to inspect the full generated command tree.

More App recipes