mirror of
https://github.com/MadsLorentzen/ai-job-search.git
synced 2026-11-09 00:17:39 +00:00
docs(jobindex-search): align search examples with the actual CLI contract (#579)
* docs(jobindex-search): align search examples with the actual CLI contract The posted-today skill example omits the query that the shipped CLI requires, so copying it exits MISSING_REQUIRED. Supply a keyword and make the required flag explicit. Replace stale JSON-endpoint/card-parser search documentation with the implemented HTML Stash route and emitted field behavior. Run the example read directly from SKILL.md through a real CLI subprocess with loopback HTTP fixtures. Keep a separate query/page routing control; no live portal requests or production-code changes. * test(jobindex-search): cover Windows documentation newlines
This commit is contained in:
1 parent
894e3917ba
commit
3b16f80595
4 files changed
+115
-38
No files matched your search
@@ -41,11 +41,11 @@ Invoke this skill when the user wants to:
|
||||
### Search job listings
|
||||
|
||||
```bash
|
||||
bun run .agents/skills/jobindex-search/cli/src/cli.ts search [flags]
|
||||
bun run .agents/skills/jobindex-search/cli/src/cli.ts search --query "<text>" [flags]
|
||||
```
|
||||
|
||||
Key flags:
|
||||
- `--query <text>` / `-q <text>` — keyword search (job title, skill, company, city). **Required** for meaningful results.
|
||||
- `--query <text>` / `-q <text>` — keyword search (job title, skill, company, city). **Required.** Searches without a query exit with `MISSING_REQUIRED`.
|
||||
- `--jobage <days>` — filter by posting age: `1` (today), `7`, `14`, `30`, or `9999` (all, default)
|
||||
- `--sort <order>` — `score` (relevance, default) or `date` (newest first)
|
||||
- `--page <n>` — page number (1-indexed, 20 results per page, fixed)
|
||||
@@ -121,10 +121,11 @@ bun run .agents/skills/jobindex-search/cli/src/cli.ts search \
|
||||
--format json
|
||||
```
|
||||
|
||||
### Jobs posted today across all sectors
|
||||
### Jobs posted today for a keyword
|
||||
|
||||
```bash
|
||||
bun run .agents/skills/jobindex-search/cli/src/cli.ts search \
|
||||
--query python \
|
||||
--jobage 1 \
|
||||
--sort date \
|
||||
--limit 20 \
|
||||
@@ -167,5 +168,5 @@ All errors are written to **stderr** as `{ "error": "...", "code": "..." }` and
|
||||
- Page size is fixed at 20 results per page (Jobindex API limitation).
|
||||
- Area/region filtering via API params does not work — include city names in `--query` instead.
|
||||
- `--jobage 9999` is the default and includes all postings regardless of age.
|
||||
- Total count in `meta.total` uses Danish dot-thousands notation internally (e.g. `18.903`) — the CLI normalizes this to a plain integer.
|
||||
- Total count in `meta.total` comes from the numeric `searchResponse.hitcount` embedded in the search page.
|
||||
- Job IDs are string-prefixed (e.g. `h1647303`) — pass them as-is to `detail`.
|
||||
Reference in new issue
Block a user