@starfetch-js/cli 0.2.0 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +31 -4
  2. package/package.json +14 -7
package/README.md CHANGED
@@ -1,24 +1,51 @@
1
1
  # @starfetch-js/cli
2
2
 
3
- Command-line interface for Starfetch TAP/ADQL workflows.
3
+ Query Gaia, SIMBAD, VizieR, the NASA Exoplanet Archive, IRSA, and other public
4
+ astronomy TAP services from the command line. Starfetch keeps ADQL visible so
5
+ an agent result, script, or investigation can be reproduced exactly.
6
+
7
+ Requires Node.js 22 or newer.
4
8
 
5
9
  ```sh
6
10
  npm install -g @starfetch-js/cli
11
+ starfetch tap tables --service gaia
7
12
  ```
8
13
 
9
- Run once without a global install:
14
+ Run once without installing globally:
10
15
 
11
16
  ```sh
12
17
  npx -y @starfetch-js/cli tap tables --service gaia
13
18
  ```
14
19
 
20
+ ## Metadata first, then a bounded query
21
+
22
+ Inspect the live schema before writing service-specific ADQL:
23
+
15
24
  ```sh
25
+ starfetch tap availability --service gaia
16
26
  starfetch tap tables --service gaia
27
+ starfetch tap columns --service gaia --table gaiadr3.gaia_source
28
+ ```
29
+
30
+ Then run a reproducible query. `TOP` bounds the ADQL result and `--maxrec`
31
+ bounds the TAP request:
32
+
33
+ ```sh
17
34
  starfetch tap query \
18
35
  --service gaia \
19
36
  --query "SELECT TOP 5 source_id, ra, dec FROM gaiadr3.gaia_source" \
37
+ --maxrec 5 \
20
38
  --format json
21
39
  ```
22
40
 
23
- The CLI exposes TAP metadata, registry search, sync queries, explicit async
24
- jobs, and `starfetch skill` commands for installing the packaged agent skill.
41
+ ```json
42
+ [{ "source_id": "…", "ra": 56.64828, "dec": 24.38537 }]
43
+ ```
44
+
45
+ The CLI also supports VO registry discovery, explicit TAP/UWS async jobs,
46
+ CSV/TSV/VOTable output, and `starfetch skill` commands. It is intended for
47
+ public TAP services, not authenticated/private archives, image processing, or
48
+ authoritative astrophysical interpretation.
49
+
50
+ For the complete Gaia proper-motion workflow and TypeScript API, see the
51
+ [repository README](https://github.com/starfetch-js/starfetch#readme).
package/package.json CHANGED
@@ -1,15 +1,22 @@
1
1
  {
2
2
  "name": "@starfetch-js/cli",
3
- "version": "0.2.0",
4
- "description": "Command-line interface for Starfetch.",
3
+ "version": "0.2.2",
4
+ "description": "CLI for querying Gaia, SIMBAD, VizieR, and other public astronomy TAP services with reproducible ADQL.",
5
5
  "type": "module",
6
6
  "license": "MIT",
7
7
  "keywords": [
8
8
  "astronomy",
9
+ "gaia",
10
+ "simbad",
11
+ "vizier",
12
+ "exoplanets",
13
+ "nasa-exoplanet-archive",
14
+ "irsa",
15
+ "star-catalog",
16
+ "virtual-observatory",
9
17
  "tap",
10
18
  "adql",
11
- "cli",
12
- "virtual-observatory"
19
+ "cli"
13
20
  ],
14
21
  "homepage": "https://github.com/starfetch-js/starfetch#readme",
15
22
  "bugs": {
@@ -42,8 +49,8 @@
42
49
  "test": "vitest run"
43
50
  },
44
51
  "dependencies": {
45
- "@starfetch-js/core": "0.2.0",
46
- "@starfetch-js/skill": "0.2.0",
52
+ "@starfetch-js/core": "0.2.2",
53
+ "@starfetch-js/skill": "0.2.2",
47
54
  "commander": "15.0.0"
48
55
  },
49
56
  "devDependencies": {
@@ -55,5 +62,5 @@
55
62
  "publishConfig": {
56
63
  "access": "public"
57
64
  },
58
- "gitHead": "d77aa260e196f3a1aebb23221f969ec0fa5baefc"
65
+ "gitHead": "7ddba23a99ba569b9a4088daacf9c6e4ee38a48a"
59
66
  }