@rentline/cli

CLI tools for the Rentline API. Two binaries: rentline (user) and rentline-admin (admin).

Install

Published (once deployed)

npm install -g @rentline/cli

Local development

git clone <repo-url>
cd core/cli
npm install
npm run build
npm link                    # or: npm install -g .

Now rentline and rentline-admin are available globally. Re-run npm run build && npm link after pulling changes.

Alternatively, run directly without installing:

node dist/index.js <command>
node dist/admin.js <command>

Authentication

Browser login (recommended)

Opens https://rentline.xyz/cli-auth in your browser. Sign in with your Rentline account. The CLI waits and stores credentials automatically.

rentline auth login

Credentials are stored at ~/.rentline/credentials.json.

API key login

Generate a key from Settings → API Keys in the dashboard.

rentline auth login --key rl_xxx

Check status

rentline auth whoami

Logout

rentline auth logout

Quickstart — Create a property

# Create a property
rentline properties create \
  --name "123 Main St" \
  --wallet 0x<owner-address>

# → returns { "id": "prop-abc123", "name": "123 Main St", ... }

Supported create options:

• --reserve-percent <pct> — reserve holdback percentage (default: 0.1)
• --conversion-enabled <bool> — enable auto-conversion (default: true)
• --privacy-mode <mode> — public (default) or private (eERC encrypted)

Usage

Requires authentication via rentline auth login (recommended) or --api-key / RENTLINE_API_KEY env var.

rentline properties list
rentline properties get <id>
rentline properties create --name "Casa" --wallet 0x...
rentline properties update <id> [--name --wallet --reserve-percent ...]
rentline properties delete <id>
rentline payments simulate --property-id <id> --amount 1200
rentline payments list
rentline payments get <id>
rentline treasury balance <property-id>
rentline treasury reserve-balance <property-id>
rentline treasury onchain-balance <property-id>
rentline treasury history <property-id>
rentline treasury convert <payment-id>
rentline treasury bank-account
rentline treasury mt-ledger <property-id>
rentline treasury mt-ledger-transactions <property-id>

Global options:

• --api-key <key> — API key (overrides stored credentials)
• --url <url> — API base URL (default: http://localhost:6531)

Admin CLI: rentline-admin

Reads ADMIN_API_KEY from .env or environment. All user commands plus admin-only operations.

rentline-admin properties list
rentline-admin mint --to 0x... --amount 1000
rentline-admin --url https://api.rentline.xyz treasury balance <id>

Commands

Properties

| Command | Description | |---------|-------------| | properties list | List all properties | | properties get <id> | Get property by ID | | properties create --name --wallet [opts] | Create a property | | properties update <id> [opts] | Update a property | | properties delete <id> | Delete a property |

create / update options: --reserve-percent, --conversion-enabled, --privacy-mode

Payments

| Command | Description | |---------|-------------| | payments simulate --property-id --amount | Simulate ACH rent payment (amount must be > 0) | | payments list [--property-id] | List payments | | payments get <id> | Get payment by ID |

Automate

| Command | Description | |---------|-------------| | automate --property <id> --every 10m | Run automations locally (interval) | | automate --rule '<json>' [--rule ...] | Add rules as JSON (repeatable) | | automate --config ./rules.json | Load rules from JSON file | | automate status | Live terminal status table | | automate ui | Open browser dashboard | | automate fire <index> | Manually fire a rule by index |

--config format: [{"property":"<id>","every":"5m","amount":[5000,5000]}]

Treasury

| Command | Description | |---------|-------------| | treasury balance <property-id> | Ledger-based treasury balance | | treasury reserve-balance <property-id> | Live MT reserve account balance | | treasury onchain-balance <property-id> | Live Avalanche USDC wallet balance | | treasury history <property-id> | Ledger entry history | | treasury convert <payment-id> | Retry CONVERSION_FAILED payment | | treasury bank-account | Show USD virtual account bank details | | treasury mt-ledger <property-id> | MT ledger accounts | | treasury mt-ledger-transactions <property-id> | MT ledger transactions |

Admin Only

| Command | Description | |---------|-------------| | mint --to <address> --amount <amount> | Mint TestUSDC (testnet only) |

Configuration

Create a .env file in your working directory:

RENTLINE_URL=https://api.rentline.xyz
ADMIN_API_KEY=your_admin_key

Build

npm run build    # Outputs to dist/ (rentline + rentline-admin binaries)