Sha256: 36af0c01394f6a0d03b9954d2c26b130fef10514a09237e139a440227e89bf99
Contents?: true
Size: 1.99 KB
Versions: 12
Compression:
Stored size: 1.99 KB
Contents
[](https://circleci.com/gh/sul-dlss/sdr-client)
[](https://codeclimate.com/github/sul-dlss/sdr-client/maintainability)
[](https://codeclimate.com/github/sul-dlss/sdr-client/test_coverage)
[](https://badge.fury.io/rb/sdr-client)
# Sdr::Client
This is a CLI for interacting with the Stanford Digital Repository API.
The code for the SDR API server is at https://github.com/sul-dlss/sdr-api
This provides a way for consumers to easily and correctly deposit files to the SDR without requiring access to the `/dor` NFS mount or to use Hydrus. A primary design goal was for this to have as few dependencies as possible so that it can be easily distributed by `gem install sdr-client` and then it can be used as a CLI.
## Install
`gem install sdr-client`
## Usage
Log in:
```
sdr --service-url http://sdr-api-server:3000 login
```
Register a new object:
```
sdr --service-url https://sdr-api-server:3000 register --label 'hey there' \
--admin-policy 'druid:bk123gh4567' \
--collection 'druid:gh456kw9876' \
--source-id 'googlebooks:stanford_12345' file1.png file2.png
```
Deposit (register + accession) a new object:
```
sdr --service-url https://sdr-api-server:3000 deposit --label 'hey there' \
--admin-policy 'druid:bk123gh4567' \
--collection 'druid:gh456kw9876' \
--source-id 'googlebooks:stanford_12345' file1.png file2.png
```
Deposit a new object, providing metadata for files:
```
sdr --service-url https://sdr-api-server:3000 deposit --label 'hey there' \
--files-metadata '{"image42.jp2":{"mime_type":"image/jp2"},"ocr.html":{"use":"transcription"}}'
--admin-policy 'druid:bk123gh4567' \
--collection 'druid:gh456kw9876' \
--source-id 'googlebooks:stanford_12345' image42.jp2 ocr.html
```
Version data entries
12 entries across 12 versions & 1 rubygems