Skip to content

Commit

Permalink
docs(cli): Add example for updating existing dataset, update script p…
Browse files Browse the repository at this point in the history
…ath for end users
  • Loading branch information
nellh committed Jul 18, 2024
1 parent 059df1d commit 612b98c
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,33 @@ To upload or download data from OpenNeuro, login with your account.

```shell
# Run login and follow the prompts
deno run -A cli/openneuto.ts login
deno run -A https://deno.land/x/openneuro/openneuro.ts login
```

You can also create an API key on [OpenNeuro](https://openneuro.org/keygen) and specify this as an option or environment variable.

```shell
# For scripts
export OPENNEURO_API_KEY=<api_key>
deno run -A cli/openneuro.ts login --error-reporting true
deno run -A https://deno.land/x/openneuro/openneuro.ts login --error-reporting true
```

### Uploading

```shell
# Path to the dataset root (directory containing dataset_description.json)
deno run -A cli/openneuro.ts upload --affirmDefaced path/to/dataset
deno run -A https://deno.land/x/openneuro/openneuro.ts upload --affirmDefaced path/to/dataset
```

```shell
# Add files to an existing dataset
deno run -A https://deno.land/x/openneuro/openneuro.ts upload --dataset ds000001 path/to/dataset
```

```shell
# To debug issues - enable logging and provide this log to support or open a GitHub issue
export OPENNEURO_LOG=INFO
deno run -A cli/openneuro.ts upload --affirmDefaced path/to/dataset
deno run -A https://deno.land/x/openneuro/openneuro.ts upload --affirmDefaced path/to/dataset
```

## Implementation Notes
Expand Down

0 comments on commit 612b98c

Please sign in to comment.