Work with your Wayfront workspace from the terminal.
It now has first-class resource commands for the API, plus one raw escape hatch.
npx wayfrontOr install globally:
npm install -g wayfrontOAuth is the main path:
wayfront auth login acmeThat opens your browser, signs you in, and stores an OAuth session locally.
Check what you're connected to:
wayfront auth status
wayfront workspace listSwitch workspaces:
wayfront workspace use acmeThe CLI is organized by resource, similar to gh.
Available command groups:
authworkspacetemplatesclientsclient-activitiescouponsfilled-form-fieldsinvoiceslogsorder-messagesorder-tasksordersservicessubscriptionstagstasksteamticket-messagesticketsapias the raw fallback
Examples:
wayfront orders list
wayfront orders get ord_123
wayfront tickets create --json '{"subject":"Help","message":"Need a hand"}'
wayfront invoices charge inv_123 --json '{"payment_method":"manual"}'Path parameters are positional. Query parameters still use key=value:
wayfront orders list page=2
wayfront ticket-messages list ticket_123 limit=50For request bodies, use --json:
wayfront clients create --json '{"email":"jane@example.com","name":"Jane"}'
wayfront orders update ord_123 --json '{"status":"in_progress"}'wayfront templates pull
wayfront templates push
wayfront templates resetOr work on a single template:
wayfront templates pull portal.home
wayfront templates push portal.home
wayfront templates reset portal.homeThe templates/ folder is yours to version control. Pull once, make changes over time, push when ready.
The raw API command is still there for anything advanced or newly added:
wayfront api list
wayfront api list Orders
wayfront api call ordersUpdate order=ord_123 --json '{"status":"paid"}'wayfront Show connection status and help
wayfront auth login [workspace] Sign in with OAuth
wayfront auth status Show the active workspace and auth state
wayfront auth logout [workspace] Remove a saved auth session
wayfront workspace list List configured workspaces
wayfront workspace use <workspace> Switch the active workspace
wayfront templates pull [name] Pull templates, or one by name
wayfront templates push [name] Push changed templates, or one by name
wayfront templates reset [name] Reset modified templates to default
wayfront orders list|get|create|update|delete
wayfront tickets list|get|create|update|delete
wayfront invoices list|get|create|update|delete|charge|mark-paid
wayfront api list [tag] List raw API operations from api.yaml
wayfront api call <operationId> [params] Call any raw API operation by operationIdRun wayfront <resource> --help to see the commands for any specific resource.
Templates use dot-notation that maps to folders:
portal.invoices.show → templates/portal/invoices/show.twig
email.invoice_paid → templates/email/invoice_paid.twigOAuth gets you into the app API, but the app still decides what you can do.
Examples:
- workspaces without template access still can't pull or push templates
- staff without
settings_templatespermission still can't access template endpoints - non-template endpoints can still work through OAuth when the workspace allows them
Node.js 18+
