Skip to content

Commit

Permalink
rscli improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
philipbaileynar committed Feb 17, 2024
1 parent a3d7835 commit a70f317
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions content/page/dev-tools/rscli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,24 @@ The RSCLI is a command line application. To use it, open a command line prompt a
rscli --help
```

## Uploading Projects

For help uploading data, run the following command:

```bash
rscli upload --help
```

## Downloading Projects

The most common rscli use case is to download projects from the [Riverscapes Data Exchange](https://data.riverscapes.net). In the following command, replace the `<local_empty_folder>` with a path on your computer to an empty folder where the project will be downloaded. Replace the `<project_guid>` with the GUID of a project. You can obtain this GUID from the URL when viewing the project details in the Data Exchange.

```bash
rscli download <local_empty_folder> --id <project_guid>
```

You must have read permissions to access the project before you can download it. A good rule of thumb is that if you can see the project details in the Data Exchange then you can download the project. Unlike downloading projects from the Data Exchange that will result in a zip file, rscli will download the project as raw individual uncompressed files.

For help downloading data, run the following command:

```bash
Expand Down

0 comments on commit a70f317

Please sign in to comment.