README.rst 2.19 KB
Newer Older
Mark Hewitt's avatar
Mark Hewitt committed
1
2
OSDU Command Line Interface
===========================
Mark Hewitt's avatar
Mark Hewitt committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

Command-line interface for interacting with OSDU.

Usage
=====

The first time you use the CLI you should run the configure command to provide connection information and other important configuration.

.. code-block:: bash

  osdu config update

Once configured use the CLI as shown below. Omitting a command will display a list of available options.

.. code-block:: bash

  osdu <command>

For more information, specify the `-h` flag:

.. code-block:: bash

  osdu -h
  osdu <command> -h

Change Log
==========
30

Mark Hewitt's avatar
Mark Hewitt committed
31
32
33
34
35
36
0.0.23
------

- osdu version shows service versions
- added info subcommand to entitlements, legal, schema, search, unit, workflow.

Mark Hewitt's avatar
Mark Hewitt committed
37
38
39
40
41
0.0.22
------

- search query supports limit

42
43
44
45
46
0.0.21
------

- dataload verify supports reference-data {{NAMESPACE}} replacement

47
48
49
50
51
0.0.20
------

- dataload support sequence file for ordered loading (ref. standard reference-data)
 
52
53
54
55
0.0.19
------

- schema add --overwrite-existing option
56
- merge dataload checkrefs code (wip)
Mark Hewitt's avatar
Mark Hewitt committed
57
- user friendly output mode
58
- improved dataload helper text
59
- support for python 3.10
60

61
62
63
64
65
0.0.18
------

- split global options in help text for clarity
- search table output fields changed
Mark Hewitt's avatar
Mark Hewitt committed
66

Mark Hewitt's avatar
Mark Hewitt committed
67
68
69
70
71
0.0.17
------

- change osducli references to osdu

Mark Hewitt's avatar
Mark Hewitt committed
72
73
74
75
76
0.0.16
------

- fix ingestion batch sizes
  
Mark Hewitt's avatar
Mark Hewitt committed
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
0.0.15
------

- *entitlements members add* - added role option
- *entitlements members remove* command added

0.0.14
------
- callable as osdu instead of osducli
- search query & search id commands
- dataload ingest --skip-existing option
- Add legal service and list tags
  
0.0.13
------

- workflow register / unregister commands
- dataload ingest - wait and simulate options

0.0.12
------

- Fix config permissions

0.0.11
------

- schema commands
- dataload batching imporvements

0.0.10
------

- refeactor code to use click instead of knack

0.0.9
-----

- entitlements commands

0.0.8
-----

- use osdu-sdk 0.0.2
  
0.0.7
-----

- Uses osdu-sdk for backend code
  
0.0.6
-----

- Refactor of connection code

0.0.3
-----

- Bulk upload commands (file upload still missing)
- Interactive login
- Config improvements
- Additional testing

0.0.2
-----

- Cleanup and diverse fixes
  
0.0.1
-----

- Initial release.