Skip to content

Commit 369612e

Browse files
committed
Rename CLI binary to uspto and migrate install/update/config paths
1 parent ce765ad commit 369612e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+1549
-381
lines changed

.goreleaser.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ builds:
1212
- arm64
1313
ldflags:
1414
- -s -w -X github.com/smcronin/uspto-cli/cmd.version={{.Version}}
15-
binary: uspto-cli
15+
binary: uspto
1616

1717
archives:
1818
- formats:
@@ -21,7 +21,7 @@ archives:
2121
- goos: windows
2222
formats:
2323
- zip
24-
name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
24+
name_template: "uspto_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
2525

2626
checksum:
2727
name_template: "checksums.txt"

CLAUDE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ tests/
4040

4141
## Building
4242
```bash
43-
go build -o uspto-cli . # Build binary
44-
go install . # Install to $GOBIN
43+
go build -o uspto . # Build binary
44+
go install ./cmd/uspto # Install `uspto` to $GOBIN
4545
go vet ./... # Static analysis
4646
```
4747

@@ -64,5 +64,7 @@ All endpoints under /api/v1/
6464

6565
## Distribution
6666
```bash
67-
go install github.com/smcronin/uspto-cli@latest
67+
go install github.com/smcronin/uspto-cli/cmd/uspto@latest
6868
```
69+
70+

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to uspto-cli
1+
# Contributing to uspto
22

33
Thanks for your interest. This is a small personal project, so contributions follow a different process than most open-source repos.
44

@@ -33,7 +33,7 @@ A diff tells me *what* changed. The prompt tells me *why* and *whether I agree w
3333
## Development
3434

3535
```bash
36-
go build -o uspto-cli .
36+
go build -o uspto .
3737
go vet ./...
3838
go test ./...
3939
go test ./tests/integration/ -v -count=1 -timeout 600s # requires USPTO_API_KEY
@@ -42,3 +42,4 @@ go test ./tests/integration/ -v -count=1 -timeout 600s # requires USPTO_API_KEY
4242
## License
4343

4444
By contributing, you agree that your contributions will be licensed under the MIT License.
45+

EXAMPLES.md

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Examples & Use Cases
22

3-
Real-world scenarios showing what you can do with `uspto-cli`. Every example runs in a single terminal command.
3+
Real-world scenarios showing what you can do with `uspto`. Every example runs in a single terminal command.
44

55
## See What Your Competitors Are Filing
66

77
Pull every patent application filed by a company and export it to a spreadsheet:
88

99
```bash
1010
# Export all of Google's recent filings to CSV
11-
uspto-cli search --assignee "Google" --filed-within 1y --download csv > google_filings.csv
11+
uspto search --assignee "Google" --filed-within 1y --download csv > google_filings.csv
1212

1313
# See what Apple is patenting in machine learning (CPC class G06N)
14-
uspto-cli search --assignee "Apple" --cpc G06N --granted --limit 50
14+
uspto search --assignee "Apple" --cpc G06N --granted --limit 50
1515

1616
# 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
17+
uspto search --assignee "Samsung Electronics" --granted-after 2025-01-01 --all -f csv > samsung_2025.csv
1818
```
1919

2020
## Find Prior Art
@@ -23,13 +23,13 @@ Search by technology area, keywords, and classification codes to find relevant p
2323

2424
```bash
2525
# Search by title keywords
26-
uspto-cli search --title "solid state battery electrolyte" --granted --limit 20
26+
uspto search --title "solid state battery electrolyte" --granted --limit 20
2727

2828
# Narrow by CPC classification
29-
uspto-cli search --cpc H01M10/0562 --filed-within 3y --all
29+
uspto search --cpc H01M10/0562 --filed-within 3y --all
3030

3131
# Search by inventor name across all their filings
32-
uspto-cli search --inventor "Goodenough" --sort filingDate:desc
32+
uspto search --inventor "Goodenough" --sort filingDate:desc
3333
```
3434

3535
## Read the Actual Patent Text
@@ -38,13 +38,13 @@ Extract claims, abstracts, and full specifications from granted patents — no P
3838

3939
```bash
4040
# Get the claims of a specific patent
41-
uspto-cli app claims 16123456
41+
uspto app claims 16123456
4242

4343
# Get everything: abstract, claims, citations, full description
44-
uspto-cli app fulltext 16123456
44+
uspto app fulltext 16123456
4545

4646
# Just the prior art citations (patent and non-patent references)
47-
uspto-cli app citations 16123456
47+
uspto app citations 16123456
4848
```
4949

5050
## Download Every Document in a Patent's File History
@@ -53,13 +53,13 @@ Get all the PDFs — office actions, responses, drawings, everything the USPTO h
5353

5454
```bash
5555
# Download the entire file wrapper (all PDFs)
56-
uspto-cli app download-all 16123456
56+
uspto app download-all 16123456
5757

5858
# Or just see what documents are available first
59-
uspto-cli app docs 16123456
59+
uspto app docs 16123456
6060

6161
# Download a specific document by index
62-
uspto-cli app download 16123456 3
62+
uspto app download 16123456 3
6363
```
6464

6565
## Trace a Patent Family Tree
@@ -68,10 +68,10 @@ Follow the chain of continuations, divisionals, and continuations-in-part to see
6868

6969
```bash
7070
# Build the family tree (follows parent/child chains)
71-
uspto-cli family 16123456 --depth 3
71+
uspto family 16123456 --depth 3
7272

7373
# Get the continuity data for a single application
74-
uspto-cli app continuity 16123456
74+
uspto app continuity 16123456
7575
```
7676

7777
## Due Diligence: Get Everything on a Patent
@@ -80,13 +80,13 @@ One command pulls together metadata, prosecution history, assignments, continuit
8080

8181
```bash
8282
# Full application summary (makes 5 API calls, returns unified view)
83-
uspto-cli summary 16123456
83+
uspto summary 16123456
8484

8585
# Who owns it? Check assignment/transfer history
86-
uspto-cli app assignments 16123456
86+
uspto app assignments 16123456
8787

8888
# What happened during prosecution?
89-
uspto-cli app transactions 16123456
89+
uspto app transactions 16123456
9090
```
9191

9292
## Monitor PTAB Proceedings
@@ -95,16 +95,16 @@ Track inter partes reviews (IPRs), post-grant reviews, and other Patent Trial an
9595

9696
```bash
9797
# Find all IPR proceedings against a specific patent
98-
uspto-cli ptab search --type IPR --patent 9876543
98+
uspto ptab search --type IPR --patent 9876543
9999

100100
# Get details on a specific proceeding
101-
uspto-cli ptab get IPR2023-00001
101+
uspto ptab get IPR2023-00001
102102

103103
# Download all IPR decisions to a file
104-
uspto-cli ptab decisions --download csv > ipr_decisions.csv
104+
uspto ptab decisions --download csv > ipr_decisions.csv
105105

106106
# Check appeal decisions
107-
uspto-cli ptab appeals "artificial intelligence"
107+
uspto ptab appeals "artificial intelligence"
108108
```
109109

110110
## Download Bulk Patent Data
@@ -113,13 +113,13 @@ The USPTO publishes weekly data dumps of patent grants, applications, and more:
113113

114114
```bash
115115
# See what bulk data products are available
116-
uspto-cli bulk search "patent grant"
116+
uspto bulk search "patent grant"
117117

118118
# List files in a specific product
119-
uspto-cli bulk files PTGRXML
119+
uspto bulk files PTGRXML
120120

121121
# Download a specific weekly file
122-
uspto-cli bulk download PTGRXML ipg260101.zip -o ./data/
122+
uspto bulk download PTGRXML ipg260101.zip -o ./data/
123123
```
124124

125125
## Export Data for Spreadsheets and Dashboards
@@ -128,13 +128,13 @@ Every command can output to CSV for Excel, Google Sheets, or any data tool:
128128

129129
```bash
130130
# CSV export for spreadsheet analysis
131-
uspto-cli search --assignee "Tesla" --all -f csv > tesla_portfolio.csv
131+
uspto search --assignee "Tesla" --all -f csv > tesla_portfolio.csv
132132

133133
# Get filing counts by technology area
134-
uspto-cli search --assignee "Microsoft" --facets cpcSectionLabelName -f json
134+
uspto search --assignee "Microsoft" --facets cpcSectionLabelName -f json
135135

136136
# Export PTAB proceedings
137-
uspto-cli ptab search --type IPR --all -f csv > all_iprs.csv
137+
uspto ptab search --type IPR --all -f csv > all_iprs.csv
138138
```
139139

140140
## Let Your AI Agent Do Patent Research
@@ -143,10 +143,10 @@ The CLI is designed for AI agents. Any agent that can run terminal commands can
143143

144144
```bash
145145
# Agents get structured output with metadata
146-
uspto-cli search --title "LLM training" -f json --minify --quiet
146+
uspto search --title "LLM training" -f json --minify --quiet
147147

148148
# Dry-run mode shows the API call without executing (useful for agent planning)
149-
uspto-cli search --assignee "OpenAI" --dry-run
149+
uspto search --assignee "OpenAI" --dry-run
150150

151151
# Exit codes tell agents exactly what happened
152152
# 0=success, 2=bad input, 3=auth error, 4=not found, 5=rate limited
@@ -157,6 +157,8 @@ Agents can chain commands together to build complex research workflows — searc
157157
## Getting Started
158158

159159
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)
160+
2. Install: `go install github.com/smcronin/uspto-cli/cmd/uspto@latest` or grab a binary from [releases](https://github.com/smcronin/uspto-cli/releases)
161161
3. Set your key: `export USPTO_API_KEY=your-key-here`
162-
4. Start searching: `uspto-cli search --title "your technology" --limit 5`
162+
4. Start searching: `uspto search --title "your technology" --limit 5`
163+
164+

0 commit comments

Comments
 (0)