Skip to content

Commit 960d2d3

Browse files
committed
DOCS: update generated reference.rst
1 parent 8f8eb91 commit 960d2d3

File tree

1 file changed

+54
-48
lines changed

1 file changed

+54
-48
lines changed

docs/source/cli/reference.rst

Lines changed: 54 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,40 @@ Option Types Formatting
1010
-----------------------
1111

1212

13-
.. _cli-metavar-FIELD-COMP-VALUE:
13+
.. _cli-metavar-ASSET-TYPE:
1414

1515

16-
FIELD COMP VALUE...
17-
...................
16+
ASSET-TYPE
17+
..........
1818

1919

20-
A comparison query format where FIELD is a
21-
property of the item-type and COMP is one of lt, lte, gt, gte and VALUE is
22-
the number or date to compare against.
20+
Specify Asset-Type(s) of interest. Case-insenstive,
21+
supports glob-matching, e.g. ``visual*`` specifies ``visual`` and
22+
``visual_xml``.
2323

24-
Note: ISO-8601 variants are supported. For example, ``2017`` is short for
25-
``2017-01-01T00:00:00+00:00``.
2624

25+
.. _cli-metavar-ITEM-TYPE:
2726

28-
.. _cli-metavar-FIELD-VALUES:
2927

28+
ITEM-TYPE
29+
.........
3030

31-
FIELD VALUES...
32-
...............
3331

32+
Specify Item-Type(s) of interest. Case-insensitive,
33+
supports glob-matching, e.g. ``psscene*`` means ``PSScene3Band`` and
34+
``PSScene4Band``. The ``all`` value specifies every Item-Type.
3435

35-
Specifies an 'in' query where FIELD is a property
36-
of the item-type and VALUES is space or comma separated text or numbers.
36+
37+
.. _cli-metavar-FILTER:
38+
39+
40+
FILTER
41+
......
42+
43+
44+
Specify a Data API search filter provided as JSON.
45+
``@-`` specifies stdin and ``@filename`` specifies reading from a file
46+
named 'filename'. Otherwise, the value is assumed to be JSON.
3747

3848

3949
.. _cli-metavar-GEOM:
@@ -49,40 +59,30 @@ reading from a file named 'filename'. Otherwise, the value is assumed to
4959
be GeoJSON.
5060

5161

52-
.. _cli-metavar-FILTER:
53-
54-
55-
FILTER
56-
......
57-
58-
59-
Specify a Data API search filter provided as JSON.
60-
``@-`` specifies stdin and ``@filename`` specifies reading from a file
61-
named 'filename'. Otherwise, the value is assumed to be JSON.
62+
.. _cli-metavar-FIELD-VALUES:
6263

6364

64-
.. _cli-metavar-ITEM-TYPE:
65-
65+
FIELD VALUES...
66+
...............
6667

67-
ITEM-TYPE
68-
.........
6968

69+
Specifies an 'in' query where FIELD is a property
70+
of the item-type and VALUES is space or comma separated text or numbers.
7071

71-
Specify Item-Type(s) of interest. Case-insensitive,
72-
supports glob-matching, e.g. ``psscene*`` means ``PSScene3Band`` and
73-
``PSScene4Band``. The ``all`` value specifies every Item-Type.
7472

73+
.. _cli-metavar-FIELD-COMP-VALUE:
7574

76-
.. _cli-metavar-ASSET-TYPE:
7775

76+
FIELD COMP VALUE...
77+
...................
7878

79-
ASSET-TYPE
80-
..........
8179

80+
A comparison query format where FIELD is a
81+
property of the item-type and COMP is one of lt, lte, gt, gte and VALUE is
82+
the number or date to compare against.
8283

83-
Specify Asset-Type(s) of interest. Case-insenstive,
84-
supports glob-matching, e.g. ``visual*`` specifies ``visual`` and
85-
``visual_xml``.
84+
Note: ISO-8601 variants are supported. For example, ``2017`` is short for
85+
``2017-01-01T00:00:00+00:00``.
8686

8787

8888
General Options
@@ -118,11 +118,11 @@ General Commands
118118
----------------
119119

120120

121-
:ref:`cli-command-help` Get command help
121+
:ref:`cli-command-help` None
122122

123123

124124

125-
:ref:`cli-command-init` Login using email/password
125+
:ref:`cli-command-init` None
126126

127127

128128

@@ -175,31 +175,31 @@ Data API
175175
--------
176176

177177

178-
:ref:`cli-command-create-search` Create a saved search
178+
:ref:`cli-command-create-search` None
179179

180180

181181

182-
:ref:`cli-command-download` Activate and download
182+
:ref:`cli-command-download` None
183183

184184

185185

186-
:ref:`cli-command-filter` Output a AND filter as JSON to stdout.
186+
:ref:`cli-command-filter` None
187187

188188

189189

190-
:ref:`cli-command-saved-search` Execute a saved search
190+
:ref:`cli-command-saved-search` None
191191

192192

193193

194-
:ref:`cli-command-search` Execute a quick search.
194+
:ref:`cli-command-search` None
195195

196196

197197

198-
:ref:`cli-command-searches` List searches
198+
:ref:`cli-command-searches` None
199199

200200

201201

202-
:ref:`cli-command-stats` Get search stats
202+
:ref:`cli-command-stats` None
203203

204204

205205

@@ -304,7 +304,7 @@ Usage: download [OPTIONS]
304304
- Format
305305

306306
* - limit
307-
- Limit the number of items.
307+
- Limit the number of items. Default: None
308308

309309
- NUMBER
310310

@@ -471,7 +471,7 @@ Usage: saved-search [OPTIONS] [SEARCH_ID]
471471
- BOOLEAN
472472

473473
* - limit
474-
- Limit the number of items.
474+
- Limit the number of items. Default: 100
475475

476476
DEFAULT: `100`
477477
- NUMBER
@@ -499,7 +499,7 @@ Usage: search [OPTIONS]
499499
- Format
500500

501501
* - limit
502-
- Limit the number of items.
502+
- Limit the number of items. Default: 100
503503

504504
DEFAULT: `100`
505505
- NUMBER
@@ -588,6 +588,12 @@ Usage: searches [OPTIONS]
588588
DEFAULT: `True`
589589
- BOOLEAN
590590

591+
* - limit
592+
- Limit the number of items. Default: 10
593+
594+
DEFAULT: `10`
595+
- NUMBER
596+
591597
.. index:: stats
592598

593599
.. _cli-command-stats:

0 commit comments

Comments
 (0)