LendWorksLendWorksDocs

Developer CLI (Coming Soon)

Command-line tools for building, testing, and managing LendWorks apps.

Overview

The LendWorks Developer CLI will provide command-line tools for the full app development lifecycle — from scaffolding a new project to listening for webhooks locally.

Status: The CLI is currently in development. This page previews the planned commands and functionality.

Installation

npm install -g @lendworks/cli

Requires Node.js 18 or later.

Planned Commands

lw init

Scaffold a new LendWorks app project with boilerplate configuration.

lw init my-integration

Generates:

  • Project structure with TypeScript config
  • OAuth callback handler
  • Webhook endpoint with signature verification
  • Environment variable templates
  • Example API calls

lw login

Authenticate the CLI with your developer account.

lw login

Opens a browser window for OAuth authentication and stores credentials locally.

lw apps

Manage your registered apps.

# List all apps
lw apps list

# Show details for a specific app
lw apps info lw_app_xxxxxxxxxxxx

# Create a new app
lw apps create --name "My Integration" --redirect-uri https://localhost:3000/callback

lw webhooks listen

Forward webhook events to your local development server.

lw webhooks listen --port 3000 --path /webhooks/lendworks

This command creates a secure tunnel and registers a temporary webhook subscription, forwarding events to your local server in real time. Events are displayed in the terminal with formatted output for easy debugging.

Listening for webhook events on http://localhost:3000/webhooks/lendworks
Connected to sandbox environment

[10:15:03] lead.created       → 200 OK (42ms)
[10:15:08] lead.status_changed → 200 OK (38ms)
[10:15:12] deal.funded         → 500 Error (15ms) — retrying...

lw data

Interact with the App Data Store from the command line.

# Get a value
lw data get settings/sync-config

# Set a value
lw data set settings/sync-config '{"syncInterval": 3600}'

# Delete a value
lw data delete settings/sync-config

# List keys in a namespace
lw data list settings

lw sandbox

Manage your sandbox environment.

# Check sandbox status
lw sandbox status

# Reset sandbox data to defaults
lw sandbox reset

# Seed specific resources
lw sandbox seed --leads 100 --applications 50

Stay Updated

The CLI is actively in development. Watch the changelog for release announcements.