404
+ +Page not found
+ + +'+ escapeHtml(title) + '
' + escapeHtml(summary) +'
+
+
+
+ Page not found
+ + +Command-line client for the Dataverse API.
+dataverse --help
+Command-line client for the Dataverse API. It uses dans-dataverse-client-lib to send queries to the Dataverse API. It is +currently work in progress. The target version of Dataverse is kept in sync with the latest installed by the DANS Data Stations, for example +Data Station Archaeology.
+dataverse <object-type> [options] <target> <command> [options]
+<object-type>: the type of object to operate on, e.g. dataset, file, collection (i.e. a "dataverse" or "subverse").<target>: the target object, e.g. the DOI of a dataset. This argument can also be a file with a list of targets. The targets must be separated by
+ whitespace and/or newlines, so in general a file with one target per line will work. A dash (-) can be used to read targets from standard input. In the case
+ of the collection object type, leaving out the target will cause the command to default to the root dataverse.<command>: the command to execute on the target object. The available commands depend on the object type; for example, for a dataset it could be
+ publish, delete-draft, etc. See the help for the specific object type for a list of available commands. If a list of targets is provided, the command
+ will be executed on each target in turn, with exactly the same arguments.--parameters-file f option¶Some commands accept a parameters file as input. This is generally a CSV file with target IDs and command parameters. (However, see the help of the command for
+the specifics.) The --parameters-file option allows you to perform batch tasks on objects without being restricted to the same arguments for each object. For
+example, you could assign different roles to different users on different collections.
dataverse <object-type> [options] <command> --parameters-file <file> [other options]
+See dataverse --help for a list of available commands.
# Publish one dataset
+dataverse dataset doi:10.5072/dans-2xg-4y5 publish
+
+# Publish all datasets in the file dataset-list.txt
+dataverse dataset dataset-list.txt publish
+
+# Publish two datasets, sending the DOIs through standard input
+echo doi:10.5072/dans-2xg-4y5 doi:10.5072/dans-4zy-aab | dataverse dataset - publish
+
+# Add roles to datasets as specified in role-assignments.csv
+dataverse dataset role-assigment add --parameters-file role-assignments.csv
+Currently, this project is built as an RPM package for RHEL8 and later. The RPM will install the binaries to
+/opt/dans.knaw.nl/dd-dataverse-cli and the configuration files to /etc/opt/dans.knaw.nl/dd-dataverse-cli.
For installation on systems that do no support RPM and/or systemd:
+/opt/dans.knaw.nl/dd-dataverse-cli./opt/dans.knaw.nl/dd-dataverse-cli/bin/dd-dataverse-cli server /opt/dans.knaw.nl/dd-dataverse-cli/cfg/config.ymlPrerequisites:
+Steps:
+git clone https://github.com/DANS-KNAW/dd-dataverse-cli.git
+cd dd-dataverse-cli
+mvn clean install
+If the rpm executable is found at /usr/local/bin/rpm, the build profile that includes the RPM
+packaging will be activated. If rpm is available, but at a different path, then activate it by using
+Maven's -P switch: mvn -Pprm install.
Alternatively, to build the tarball execute:
+mvn clean install assembly:single
+' + escapeHtml(summary) +'
' + noResultsText + '
'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 0000000..ab999f7 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"dd-dataverse-cli \u00b6 Command-line client for the Dataverse API. SYNOPSIS \u00b6 dataverse --help DESCRIPTION \u00b6 Command-line client for the Dataverse API. It uses dans-dataverse-client-lib to send queries to the Dataverse API . It is currently work in progress. The target version of Dataverse is kept in sync with the latest installed by the DANS Data Stations, for example Data Station Archaeology . Basic syntax \u00b6 dataverse