CLI Quickstart

The TIDY CLI lets you manage properties, schedule cleanings, and track maintenance directly from your terminal. It wraps the TIDY REST API with a developer-friendly interface.

Install

Global install (recommended)

npm install -g @tidyapp/cli

Run without installing

npx @tidyapp/cli message "Schedule a cleaning"

Authenticate

Log in with your TIDY account:

$ tidy login
Email: you@example.com
Password: ********
✓ Logged in successfully. Token saved.

Alternatively, set the token directly:

export TIDY_API_TOKEN=your-api-token

Your First Commands

Send a natural language request

$ tidy message "Schedule a 2-hour cleaning next Tuesday at 123 Main St"
✓ Booking created: #78901
  Date: Tuesday March 25, 1:00 PM - 5:00 PM
  Address: 123 Main St

List your properties

$ tidy addresses list
ID      Name              Address
1001    Beach House       123 Main St, Miami FL
1002    Downtown Office   456 Oak Ave, Austin TX

List upcoming bookings

$ tidy bookings list --upcoming
ID      Date         Address          Status
78901   Mar 25       123 Main St      Confirmed
78902   Mar 27       456 Oak Ave      Pending

Report a maintenance issue

$ tidy issues create --address 1001 --urgent "Kitchen faucet leaking"
✓ Issue created: #4567
  Priority: Urgent
  Status: Open

Next Steps

• CLI Reference — Full command documentation
• Authentication — Token management details
• MCP Server — Let your AI agent use TIDY directly