Pp Apartments — Workflow

Overview

How the pp-apartments skill works, step by step.

Source Workflow

Codex skill workflow.

Step-by-step Workflow

Apartments.com — Printing Press CLI

Prerequisites: Install the CLI

This skill drives the apartments-pp-cli binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:

Install via the Printing Press installer:

npx -y @mvanhorn/printing-press install apartments --cli-only

Verify: apartments-pp-cli --version
Ensure $GOPATH/bin (or $HOME/go/bin) is on $PATH.

If the npx install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.3 or newer):

go install github.com/mvanhorn/printing-press-library/library/other/apartments/cmd/apartments-pp-cli@latest

If --version reports "command not found" after install, the install step did not put the binary on $PATH. Do not proceed with skill commands until verification succeeds.

When to Use This CLI

Use this CLI when an agent or human needs structured Apartments.com data and needs the workflows the website itself doesn't expose: cross-search diffs over time, $/sqft and total-cost-of-occupancy rankings, multi-slug union queries, side-by-side comparison, and digest-style summaries. Reach for it for relocation tracking, value-per-dollar screens across shortlists, leasing-agent weekly digests, and any rental-search scenario that needs JSON + offline composition. Skip it for one-off browsing — the apartments.com website is fine for that.

When Not to Use This CLI

Do not activate this CLI for requests that require creating, updating, deleting, publishing, commenting, upvoting, inviting, ordering, sending messages, booking, purchasing, or changing remote state. This printed CLI exposes read-only commands for inspection, export, sync, and analysis.

Unique Capabilities

These capabilities aren't available in any other tool for this API.

Time-series intelligence

watch — Re-run a stored search and surface what's NEW, REMOVED, or PRICE-CHANGED since the last sync.

Pick this when an agent is tracking a relocation over time and needs a reproducible 'what changed since last week' digest, not a fresh search.
```
apartments-pp-cli watch austin-2br --json --since 7d
```
drops — List listings whose max-rent dropped by ≥N% within a time window.

Pick this when timing the market or watching for distressed listings.
```
apartments-pp-cli drops --since 14d --min-pct 5 --json
```
stale — Flag listings whose price and availability haven't changed in N days — often phantom or stuck.

Pick this when a listing seems too good to be true; stale ones often are.
```
apartments-pp-cli stale --days 30 --json --select url,maxrent,unchanged_days
```
phantoms — Surface listings flagged by a three-signal join: 404 on re-fetch, dropped from saved-search results, or stale ≥45 days.

Pick this when prepping a shortlist for tour scheduling — phantoms waste tour slots.
```
apartments-pp-cli phantoms --json
```
history — Time-series of every observation of one listing — rent, availability, status.

Pick this when reasoning about a single listing's price trajectory.
```
apartments-pp-cli history https://www.apartments.com/example-property-1234 --json
```

Cross-market joins

nearby — Fan out a search across multiple cities, zips, or neighborhoods and return one ranked, deduped list.

Pick this when an agent needs a single ranked feed across multiple search slugs without writing a fan-out loop.
```
apartments-pp-cli nearby austin-tx round-rock-tx pflugerville-tx --beds 2 --price-max 2500 --rank sqft --agent
```

Local-store math

value — Rank synced listings by 12-month total cost (rent + pet rent + pet deposit + pet fee), filtered to your hard budget.

Pick this when budget is binding and pet fees might push a listing over the line.
```
apartments-pp-cli value --budget 2800 --pet dog --months 12 --json --select rank,url,total_cost
```
rank — Rank synced listings by ratio metrics — price per square foot or price per bedroom.

Pick this when value-per-dollar is the goal, not 'best match' or 'lowest price'.
```
apartments-pp-cli rank --by sqft --beds 2 --price-max 2500 --json --limit 10
```
floorplans — Rank per-floor-plan rent/sqft across synced listings — same building can yield 4 plans at different ratios.

Pick this when a building has multiple floor plans and you want the cheap one specifically.
```
apartments-pp-cli floorplans --rank price-per-sqft --beds 2 --json --limit 10
```
must-have — Filter synced listings to those whose amenities array contains ALL listed terms via FTS5.

Pick this when the must-haves are free-text, not in apartments.com's amenity dropdown.
```
apartments-pp-cli must-have "in-unit washer" "covered parking" "dishwasher" --json
```

Shortlist workflows

compare — Pivot 2–8 listings into a wide table — one column per listing — with computed $/sqft and amenity overlap.

Pick this when narrowing a shortlist; the wide table makes amenity-overlap deltas obvious.
```
apartments-pp-cli compare austin-arboretum-1 austin-arboretum-2 austin-arboretum-3 --json
```
digest — Single-shot composer: new + removed + price-drops + top-5 by $/sqft + stale + phantom flags for one saved search over N days.

Pick this when an agent needs a Monday-morning summary in one call.
```
apartments-pp-cli digest --saved-search austin-2br --since 7d --format md
```
shortlist — Tag-based local shortlist table; add/show/remove listings with notes and tags.

Pick this when an agent or user is curating a shortlist; downstream commands like compare read from it.
```
apartments-pp-cli shortlist add https://www.apartments.com/example-1234 --tag austin --note "liked the kitchen"
```

Aggregations

market — Median, p10, p90 of rent and rent/sqft, pet-friendly share, by city/state and bed count.

Pick this when an agent needs to anchor 'is this a fair price' against the local distribution.
```
apartments-pp-cli market austin-tx --beds 2 --json
```

HTTP Transport

This CLI uses Chrome-compatible HTTP transport for browser-facing endpoints. It does not require a resident browser process for normal API calls.

Discovery Signals

This CLI was generated with browser-observed traffic context.

Capture coverage: 0 API entries from 0 total network entries
Protocols: html-ssr (95% confidence)
Generation hints: use Surf with Chrome TLS fingerprint at runtime (UsesBrowserHTTPTransport), all responses are HTML/SSR — extract via html_extract mode: page, no clearance cookie capture; no resident browser sidecar, schema.org microdata (meta itemprop=streetAddress|addressLocality|addressRegion|postalCode) plus data-beds / data-baths / data-maxrent attributes are the primary extraction targets
Candidate command ideas: rentals — Path-slug search is the primary entry point at apartments.com; listing — Listing detail page extracts schema.org microdata
Caveats: protection-active: Apartments.com (CoStar) employs Akamai-style bot detection. stdlib HTTP returns 403; Surf with Chrome TLS fingerprint clears it. Watch for protection escalation that might require Chrome-clearance cookie import or full-browser fallback in future versions.

Command Reference

listing — Fetch a single Apartments.com listing detail page by URL or property ID, parsing rent, beds/baths, address, amenities, and pet policy.

apartments-pp-cli listing <property_id> — Fetch one Apartments.com listing detail page and parse schema.org microdata.

rentals — Search Apartments.com rental listings by city, beds, baths, price, and pet policy. Returns parsed listing placards.

apartments-pp-cli rentals — Run a path-slug search at apartments.com and return listing placards parsed from the HTML response.

Hand-written commands

apartments-pp-cli sync-search <saved-search> — Run a saved search against apartments.com and snapshot placards into the local store.
apartments-pp-cli watch <saved-search> — Diff the latest sync of a saved search against the previous; emit NEW / REMOVED / PRICE-CHANGED listings.
apartments-pp-cli nearby <slug...> — Fan out a search across multiple city/zip/neighborhood slugs and return one ranked, deduped list.
apartments-pp-cli value — Rank synced listings by 12-month total cost of occupancy (rent + pet rent + pet deposit + pet fee).
apartments-pp-cli rank — Rank synced listings by ratio metrics — $/sqft or $/bed.
apartments-pp-cli compare <url-or-id...> — Pivot 2–8 listings into a wide table — one column per listing — with computed $/sqft and amenity overlap.
apartments-pp-cli drops — List listings whose max-rent dropped by ≥N% within a time window.
apartments-pp-cli stale — Flag listings whose price and availability have not changed in N days — phantom or stuck signal.
apartments-pp-cli phantoms — Surface listings flagged by a three-signal union: 404 on re-fetch, dropped from saved-search results, or stale ≥45...
apartments-pp-cli market <city-state> — Aggregate synced listings: median, p10, p90 of rent and rent/sqft, plus pet-friendly share.
apartments-pp-cli history <url-or-id> — Time-series of every observation of one listing — rent, availability, status.
apartments-pp-cli digest — Weekly digest composer: new + removed + price-drops + top-by-sqft + stale + phantoms in one structured output.
apartments-pp-cli floorplans — Rank per-floor-plan rent/sqft across synced listings.
apartments-pp-cli must-have <term...> — Filter synced listings to those whose amenities array contains ALL listed terms via FTS5.
apartments-pp-cli shortlist — Local shortlist table — add / show / remove listings with notes and tags.

Freshness Contract

This printed CLI owns bounded freshness only for registered store-backed read command paths. In --data-source auto mode, those paths check sync_state and may run a bounded refresh before reading local data. --data-source local never refreshes. --data-source live reads the API and does not mutate the local store. Set APARTMENTS_NO_AUTO_REFRESH=1 to skip the freshness hook without changing source selection.

When JSON output uses the generated provenance envelope, freshness metadata appears at meta.freshness. Treat it as current-cache freshness for the covered command path, not a guarantee of complete historical backfill or API-specific enrichment.

Finding the right command

When you know what you want to do but not which command does it, ask the CLI directly:

apartments-pp-cli which "<capability in your own words>"

which resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code 0 means at least one match; exit code 2 means no confident match — fall back to --help or use a narrower query.

Recipes

Three-neighborhood relocation hunt

apartments-pp-cli nearby austin-tx round-rock-tx pflugerville-tx --beds 2 --price-max 2500 --pets dog --rank sqft --json --select url,addressLocality,maxrent,sqft,price_per_sqft

Single ranked feed across three target neighborhoods, deduped by listing URL, with --select keeping only the columns the agent needs.

Weekly leasing-agent digest

apartments-pp-cli digest --saved-search client-rachel --since 7d --format md

Composes new / removed / price-drops / top-5-by-sqft / stale / phantom flags for a single client search into a markdown report ready to paste into email.

Total-cost screen with hard budget

apartments-pp-cli value --budget 2800 --pet dog --months 12 --json --select rank,url,maxrent,pet_rent,total_cost,price_per_sqft

Ranks the synced listings by 12-month total cost (rent + pet rent + pet deposit + pet fee), filtered to under-budget rows only.

Phantom-detection sweep before tour scheduling

apartments-pp-cli phantoms --json --select url,reason,unchanged_days

Three-signal union — 404, dropped from saved search, stale ≥45 days. Filter your shortlist before booking tours so you don't drive across town to a leased unit.

Offline FTS amenity intersect

apartments-pp-cli must-have "in-unit washer" "covered parking" "dishwasher" --json --select url,addressLocality,maxrent,amenities

Path filter for amenities apartments.com's filter dropdown doesn't expose. FTS5 AND-join over the synced amenities array.

Auth Setup

No authentication required.

Run apartments-pp-cli doctor to verify setup.

Agent Mode

Add --agent to any command. Expands to: --json --compact --no-input --no-color --yes.

Pipeable — JSON on stdout, errors on stderr
Filterable — --select keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:
```
apartments-pp-cli listing example-property --agent --select id,name,status
```
Previewable — --dry-run shows the request without sending
Offline-friendly — sync/search commands can use the local SQLite store when available
Non-interactive — never prompts, every input is a flag
Read-only — do not use this CLI for create, update, delete, publish, comment, upvote, invite, order, send, or other mutating requests

Response envelope

Commands that read from the local store or the API wrap output in a provenance envelope:

{
  "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
  "results": <data>
}

Parse .results for data and .meta.source to know whether it's live or local. A human-readable N results (live) summary is printed to stderr only when stdout is a terminal — piped/agent consumers get pure JSON on stdout.

Agent Feedback

When you (or the agent) notice something off about this CLI, record it:

apartments-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
apartments-pp-cli feedback --stdin < notes.txt
apartments-pp-cli feedback list --json --limit 10

Entries are stored locally at ~/.apartments-pp-cli/feedback.jsonl. They are never POSTed unless APARTMENTS_FEEDBACK_ENDPOINT is set AND either --send is passed or APARTMENTS_FEEDBACK_AUTO_SEND=true. Default behavior is local-only.

Write what surprised you, not a bug report. Short, specific, one line: that is the part that compounds.

Output Delivery

Every command accepts --deliver <sink>. The output goes to the named sink in addition to (or instead of) stdout, so agents can route command results without hand-piping. Three sinks are supported:

Sink	Effect
`stdout`	Default; write to stdout only
`file:<path>`	Atomically write output to `<path>` (tmp + rename)
`webhook:<url>`	POST the output body to the URL (`application/json` or `application/x-ndjson` when `--compact`)

Unknown schemes are refused with a structured error naming the supported set. Webhook failures return non-zero and log the URL + HTTP status on stderr.

Named Profiles

A profile is a saved set of flag values, reused across invocations. Use it when a scheduled agent calls the same command every run with the same configuration - HeyGen's "Beacon" pattern.

apartments-pp-cli profile save briefing --json
apartments-pp-cli --profile briefing listing example-property
apartments-pp-cli profile list --json
apartments-pp-cli profile show briefing
apartments-pp-cli profile delete briefing --yes

Explicit flags always win over profile values; profile values win over defaults. agent-context lists all available profiles under available_profiles so introspecting agents discover them at runtime.

Exit Codes

Code	Meaning
0	Success
2	Usage error (wrong arguments)
3	Resource not found
5	API error (upstream issue)
7	Rate limited (wait and retry)
10	Config error

Argument Parsing

Parse $ARGUMENTS:

Empty, help, or --help → show apartments-pp-cli --help output
Starts with install → ends with mcp → MCP installation; otherwise → see Prerequisites above
Anything else → Direct Use (execute as CLI command with --agent)

MCP Server Installation

Install the MCP server:

go install github.com/mvanhorn/printing-press-library/library/other/apartments/cmd/apartments-pp-mcp@latest

claude mcp add apartments-pp-mcp -- apartments-pp-mcp

Verify: claude mcp list

Direct Use

Check if installed: which apartments-pp-cli If not found, offer to install (see Prerequisites at the top of this skill).
Match the user query to the best command from the Unique Capabilities and Command Reference above.

Execute with the --agent flag:

apartments-pp-cli <command> [subcommand] [args] --agent

If ambiguous, drill into subcommand help: apartments-pp-cli <command> --help.

Execution Logic

The skill executes when its trigger fires (slash command, natural-language match, or direct invocation). It reads its references, applies its rules, and produces the documented outputs.

Edge Cases

See the source skill's references/ and scripts/ folders for edge-case handling.

Failure Handling

A skill failure surfaces as a tool error or a partial output; never a silent skip. Re-run with --verbose (where applicable) for diagnostics.

Integration Notes

Claude — invoked via the Skill tool with skill: "pp-apartments".
Codex — referenced from AGENTS.md if mirrored.
Antigravity — referenced from the workspace agent rules if mirrored.
HQ Project — listed on the landing page Skills section + post-login sidebar.
MD Project (md.sgnk.ai) — file rendered from Skills/Pp Apartments/workflow.md.
Obsidian — file rendered with frontmatter + tags.

Usage Examples

Invoke via slash command or natural language matching the skill description.

Source: (none)