mirror of
https://github.com/opencultureconsulting/orcli.git
synced 2025-03-09 00:00:29 +01:00
66 lines
1.8 KiB
YAML
66 lines
1.8 KiB
YAML
name: orcli
|
|
help: OpenRefine command-line interface written in Bash
|
|
version: 0.1.0
|
|
footer: https://github.com/opencultureconsulting/orcli
|
|
|
|
dependencies:
|
|
- curl
|
|
- jq
|
|
|
|
environment_variables:
|
|
- name: OPENREFINE_URL
|
|
help: URL to OpenRefine server
|
|
default: "http://localhost:3333"
|
|
|
|
examples:
|
|
- orcli list
|
|
- orcli import csv file
|
|
- orcli import csv "https://github.com/LibraryCarpentry/lc-open-refine/raw/gh-pages/data/doaj-article-sample.csv"
|
|
- orcli info Clipboard
|
|
- orcli info 1234567890123
|
|
|
|
commands:
|
|
- name: info
|
|
help: show project metadata
|
|
args:
|
|
- name: project
|
|
help: project name or id
|
|
required: true
|
|
examples:
|
|
- info Clipboard
|
|
- info 1234567890123
|
|
|
|
- name: import
|
|
help: import commands
|
|
|
|
commands:
|
|
- name: csv
|
|
help: import comma-separated values (CSV)
|
|
args:
|
|
- name: file
|
|
help: Path to one or more files or URLs. When FILE is -, read standard input.
|
|
default: "-"
|
|
repeatable: true
|
|
flags:
|
|
- long: --separator
|
|
help: character(s) that separates columns
|
|
arg: separator
|
|
default: ","
|
|
- long: --encoding
|
|
help: set character encoding
|
|
arg: encoding
|
|
- long: --trimStrings
|
|
help: trim leading & trailing whitespace from strings
|
|
- long: --projectName
|
|
arg: projectName
|
|
help: set a name for the OpenRefine project
|
|
|
|
examples:
|
|
- orcli import csv file
|
|
- cat file | orcli import csv
|
|
- orcli import csv file --separator ; --encoding ISO-8859-1 --trimStrings --projectName example
|
|
- orcli import csv "https://github.com/LibraryCarpentry/lc-open-refine/raw/gh-pages/data/doaj-article-sample.csv"
|
|
|
|
- name: list
|
|
help: list projects on OpenRefine server
|