Commit b658e6d6 authored by Greg Harris's avatar Greg Harris
Browse files

Corrections to the README.md

parent c0d9b11d
Pipeline #74431 passed with stage
in 56 seconds
......@@ -50,24 +50,24 @@ pipenv install package_name
To invoke the CLI using the virtual environment and from within the `src` folder:
```
pipenv run python -m lascli <group> <command> <options>
pipenv run python -m lasloader.lascli <group> <command> <options>
```
Available groups are `fileload`, `ingest`, `list`, `update` and `download`. Help can be obtained with the `-h` option.
```
pipenv run python -m lascli -h
pipenv run python -m lascli fileload -h
pipenv run python -m lascli fileload convert -h
pipenv run python -m lasloader.lascli -h
pipenv run python -m lasloader.lascli fileload -h
pipenv run python -m lasloader.lascli fileload convert -h
```
A token is required to access an OSDU instance. The `-t/--token` option is used to specify the token, this is a string. As tokens are long strings we recommend that the token is stored in an environment variable. For example, on a Windows PowerShell prompt:
```
set OSDUTOKEN <token>
pipenv run python -m lascli ingest wellbore -t $OSDUTOKEN
pipenv run python -m lasloader.lascli ingest wellbore -t $OSDUTOKEN
```
Or Windows command prompt
```
set OSDUTOKEN=<token>
pipenv run python -m lascli ingest wellbore -t %OSDUTOKEN%
pipenv run python -m lasloader.lascli ingest wellbore -t %OSDUTOKEN%
```
This keeps the command line short. This can also be done for other commonly used options (e.g. `-u/--url`).
......@@ -81,7 +81,7 @@ pipenv-setup sync
Check that the version number in the `src/lasloader/__init__.py` file is correct.
### Dev install from repo
### Dev install from repo source
The LASCLI can be installed in edit mode on the command line by running
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment