orcli/src/bashly.yml

88 lines
2.5 KiB
YAML
Raw Normal View History

2022-03-25 11:16:02 +01:00
name: orcli
help: OpenRefine command-line interface written in Bash
version: 0.1.0
2022-04-04 23:00:37 +02:00
footer: https://github.com/opencultureconsulting/orcli
2022-03-25 11:16:02 +01:00
dependencies:
2022-03-25 23:02:28 +01:00
- curl
- jq
2022-03-25 11:16:02 +01:00
environment_variables:
2022-03-25 23:02:28 +01:00
- name: OPENREFINE_URL
help: URL to OpenRefine server
default: "http://localhost:3333"
2022-03-25 11:16:02 +01:00
examples:
2022-04-13 13:36:23 +02:00
- orcli import csv file
2022-04-14 12:06:54 +02:00
- orcli import csv "https://github.com/LibraryCarpentry/lc-open-refine/raw/gh-pages/data/doaj-article-sample.csv"
- orcli list
- orcli info "doaj article sample csv"
- orcli export tsv "doaj article sample csv"
- orcli export tsv "doaj article sample csv" --output doaj.tsv
2022-03-25 11:16:02 +01:00
commands:
2022-04-12 12:54:16 +02:00
- name: import
2022-04-13 13:36:23 +02:00
help: import commands
commands:
2022-04-13 23:55:47 +02:00
- 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
2022-04-14 12:06:54 +02:00
- orcli import csv "https://github.com/LibraryCarpentry/lc-open-refine/raw/gh-pages/data/doaj-article-sample.csv"
2022-04-12 12:54:16 +02:00
2022-03-25 23:02:28 +01:00
- name: list
help: list projects on OpenRefine server
2022-04-14 12:06:54 +02:00
- name: info
help: show project metadata
args:
- name: project
help: project name or id
required: true
examples:
- info Clipboard
- 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 Clipboard
- orcli export tsv Clipboard --output clipboard.tsv