Skip to content

Commit bd9ce0c

Browse files
smcroninclaude
andcommitted
Add examples and use cases doc
Walkthroughs for competitive monitoring, prior art search, patent text extraction, file wrapper downloads, family trees, PTAB tracking, bulk data, spreadsheet exports, and AI agent workflows. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent cb53c76 commit bd9ce0c

2 files changed

Lines changed: 166 additions & 0 deletions

File tree

EXAMPLES.md

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# Examples & Use Cases
2+
3+
Real-world scenarios showing what you can do with `uspto-cli`. Every example runs in a single terminal command.
4+
5+
## See What Your Competitors Are Filing
6+
7+
Pull every patent application filed by a company and export it to a spreadsheet:
8+
9+
```bash
10+
# Export all of Google's recent filings to CSV
11+
uspto-cli search --assignee "Google" --filed-within 1y --download csv > google_filings.csv
12+
13+
# See what Apple is patenting in machine learning (CPC class G06N)
14+
uspto-cli search --assignee "Apple" --cpc G06N --granted --limit 50
15+
16+
# Track a specific competitor's granted patents over time
17+
uspto-cli search --assignee "Samsung Electronics" --granted-after 2025-01-01 --all -f csv > samsung_2025.csv
18+
```
19+
20+
## Find Prior Art
21+
22+
Search by technology area, keywords, and classification codes to find relevant prior art before filing:
23+
24+
```bash
25+
# Search by title keywords
26+
uspto-cli search --title "solid state battery electrolyte" --granted --limit 20
27+
28+
# Narrow by CPC classification
29+
uspto-cli search --cpc H01M10/0562 --filed-within 3y --all
30+
31+
# Search by inventor name across all their filings
32+
uspto-cli search --inventor "Goodenough" --sort filingDate:desc
33+
```
34+
35+
## Read the Actual Patent Text
36+
37+
Extract claims, abstracts, and full specifications from granted patents — no PDF scraping needed:
38+
39+
```bash
40+
# Get the claims of a specific patent
41+
uspto-cli app claims 16123456
42+
43+
# Get everything: abstract, claims, citations, full description
44+
uspto-cli app fulltext 16123456
45+
46+
# Just the prior art citations (patent and non-patent references)
47+
uspto-cli app citations 16123456
48+
```
49+
50+
## Download Every Document in a Patent's File History
51+
52+
Get all the PDFs — office actions, responses, drawings, everything the USPTO has on file:
53+
54+
```bash
55+
# Download the entire file wrapper (all PDFs)
56+
uspto-cli app download-all 16123456
57+
58+
# Or just see what documents are available first
59+
uspto-cli app docs 16123456
60+
61+
# Download a specific document by index
62+
uspto-cli app download 16123456 3
63+
```
64+
65+
## Trace a Patent Family Tree
66+
67+
Follow the chain of continuations, divisionals, and continuations-in-part to see how a patent family evolved:
68+
69+
```bash
70+
# Build the family tree (follows parent/child chains)
71+
uspto-cli family 16123456 --depth 3
72+
73+
# Get the continuity data for a single application
74+
uspto-cli app continuity 16123456
75+
```
76+
77+
## Due Diligence: Get Everything on a Patent
78+
79+
One command pulls together metadata, prosecution history, assignments, continuity, and documents:
80+
81+
```bash
82+
# Full application summary (makes 5 API calls, returns unified view)
83+
uspto-cli summary 16123456
84+
85+
# Who owns it? Check assignment/transfer history
86+
uspto-cli app assignments 16123456
87+
88+
# What happened during prosecution?
89+
uspto-cli app transactions 16123456
90+
```
91+
92+
## Monitor PTAB Proceedings
93+
94+
Track inter partes reviews (IPRs), post-grant reviews, and other Patent Trial and Appeal Board activity:
95+
96+
```bash
97+
# Find all IPR proceedings against a specific patent
98+
uspto-cli ptab search --type IPR --patent 9876543
99+
100+
# Get details on a specific proceeding
101+
uspto-cli ptab get IPR2023-00001
102+
103+
# Download all IPR decisions to a file
104+
uspto-cli ptab decisions --download csv > ipr_decisions.csv
105+
106+
# Check appeal decisions
107+
uspto-cli ptab appeals "artificial intelligence"
108+
```
109+
110+
## Download Bulk Patent Data
111+
112+
The USPTO publishes weekly data dumps of patent grants, applications, and more:
113+
114+
```bash
115+
# See what bulk data products are available
116+
uspto-cli bulk search "patent grant"
117+
118+
# List files in a specific product
119+
uspto-cli bulk files PTGRXML
120+
121+
# Download a specific weekly file
122+
uspto-cli bulk download PTGRXML ipg260101.zip -o ./data/
123+
```
124+
125+
## Export Data for Spreadsheets and Dashboards
126+
127+
Every command can output to CSV for Excel, Google Sheets, or any data tool:
128+
129+
```bash
130+
# CSV export for spreadsheet analysis
131+
uspto-cli search --assignee "Tesla" --all -f csv > tesla_portfolio.csv
132+
133+
# Get filing counts by technology area
134+
uspto-cli search --assignee "Microsoft" --facets cpcSectionLabelName -f json
135+
136+
# Export PTAB proceedings
137+
uspto-cli ptab search --type IPR --all -f csv > all_iprs.csv
138+
```
139+
140+
## Let Your AI Agent Do Patent Research
141+
142+
The CLI is designed for AI agents. Any agent that can run terminal commands can use it — Claude Code, Codex, OpenCode, Claw, Goose, or any custom agent:
143+
144+
```bash
145+
# Agents get structured output with metadata
146+
uspto-cli search --title "LLM training" -f json --minify --quiet
147+
148+
# Dry-run mode shows the API call without executing (useful for agent planning)
149+
uspto-cli search --assignee "OpenAI" --dry-run
150+
151+
# Exit codes tell agents exactly what happened
152+
# 0=success, 2=bad input, 3=auth error, 4=not found, 5=rate limited
153+
```
154+
155+
Agents can chain commands together to build complex research workflows — search for patents, pull the full text, trace the family tree, check for PTAB challenges, and export everything to structured data.
156+
157+
## Getting Started
158+
159+
1. Get a free API key at [data.uspto.gov](https://data.uspto.gov/apis/getting-started) (requires one-time ID verification)
160+
2. Install: `go install github.com/smcronin/uspto-cli@latest` or grab a binary from [releases](https://github.com/smcronin/uspto-cli/releases)
161+
3. Set your key: `export USPTO_API_KEY=your-key-here`
162+
4. Start searching: `uspto-cli search --title "your technology" --limit 5`

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,10 @@ All commands support four output formats via `-f`:
214214
uspto-cli search --title sensor -f json --minify -q
215215
```
216216

217+
## Examples & Use Cases
218+
219+
See **[EXAMPLES.md](EXAMPLES.md)** for detailed walkthroughs: competitive monitoring, prior art search, patent family trees, file wrapper downloads, PTAB tracking, bulk data exports, AI agent workflows, and more.
220+
217221
## Agent-Friendly Design
218222

219223
Built for AI agents and automation:

0 commit comments

Comments
 (0)