151 lines
4.2 KiB
YAML
151 lines
4.2 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 import csv "https://git.io/fj5hF" --projectName "duplicates"
|
|
- orcli list
|
|
- orcli info "duplicates"
|
|
- orcli export tsv "duplicates"
|
|
- orcli export tsv "duplicates" --output "duplicates.tsv"
|
|
- |-
|
|
orcli batch << EOF
|
|
orcli import csv "https://git.io/fj5hF" --projectName "duplicates"
|
|
orcli info "duplicates"
|
|
orcli export tsv "duplicates"
|
|
EOF
|
|
|
|
flags:
|
|
- long: --quiet
|
|
short: -q
|
|
help: suppress log output, print errors only
|
|
|
|
commands:
|
|
- name: completions
|
|
help: |-
|
|
Generate bash completions
|
|
Usage: eval "\$(orcli completions)"
|
|
|
|
- name: batch
|
|
help: run tmp OpenRefine workspace and execute shell script
|
|
args:
|
|
- name: file
|
|
help: Path to one or more files. When FILE is -, read standard input.
|
|
default: "-"
|
|
repeatable: true
|
|
flags:
|
|
- long: --memory
|
|
help: maximum RAM for OpenRefine java heap space
|
|
arg: ram
|
|
default: "2048M"
|
|
- long: --port
|
|
help: PORT on which OpenRefine should listen
|
|
arg: port
|
|
default: "3333"
|
|
- long: --interactive
|
|
help: provide interactive Bash shell for playground and debugging
|
|
examples:
|
|
- orcli batch --interactive
|
|
- |-
|
|
orcli batch << EOF
|
|
orcli import csv "https://git.io/fj5hF" --projectName "duplicates"
|
|
orcli info "duplicates"
|
|
orcli export tsv "duplicates"
|
|
EOF
|
|
- |-
|
|
orcli batch --memory "2000M" --port "3334" << EOF
|
|
orcli import csv "https://git.io/fj5hF" --projectName "duplicates" &
|
|
orcli import csv "https://git.io/fj5hF" --projectName "copy" &
|
|
wait
|
|
echo "finished import"
|
|
orcli export csv "duplicates" --output duplicates.csv &
|
|
orcli export tsv "duplicates" --output duplicates.tsv &
|
|
wait
|
|
wc duplicates*
|
|
EOF
|
|
- |-
|
|
orcli batch "file1.sh" "file2.sh" - << EOF
|
|
echo "finished in \$SECONDS seconds"
|
|
EOF
|
|
|
|
- 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"
|
|
- orcli import csv "file1" "file2"
|
|
- cat "file" | orcli import csv
|
|
- orcli import csv "https://git.io/fj5hF"
|
|
- |-
|
|
orcli import csv "file" \\\\
|
|
--separator ";" \\\\
|
|
--encoding "ISO-8859-1" \\\\
|
|
--trimStrings \\\\
|
|
--projectName "duplicates"
|
|
|
|
- name: list
|
|
help: list projects on OpenRefine server
|
|
|
|
- name: info
|
|
help: show project metadata
|
|
args:
|
|
- name: project
|
|
help: project name or id
|
|
required: true
|
|
examples:
|
|
- info "duplicates"
|
|
- info 1234567890123
|
|
|
|
- name: export
|
|
help: export commands
|
|
|
|
commands:
|
|
- name: tsv
|
|
help: export tab-separated values (TSV)
|
|
args:
|
|
- name: project
|
|
help: project name or id
|
|
required: true
|
|
flags:
|
|
- long: --output
|
|
help: Write to file instead of stdout
|
|
arg: file
|
|
- long: --encoding
|
|
help: set character encoding
|
|
arg: encoding
|
|
default: "UTF-8"
|
|
examples:
|
|
- orcli export tsv "duplicates"
|
|
- orcli export tsv "duplicates" --output "duplicates.tsv"
|