OpenRefine command-line interface written in Bash. Supports batch processing (import, transform, export).

bash bashly batch cli code4lib etl openrefine openrefine-api

Go to file

Felix Lohmeier 909deadf46 set goals for 0.2.0 milestone		2022-04-04 23:00:37 +02:00
src	set goals for 0.2.0 milestone	2022-04-04 23:00:37 +02:00
.gitignore	setup dev environment	2022-03-25 11:55:57 +01:00
.gitpod.yml	shfmt and shebang	2022-03-25 22:02:28 +00:00
LICENSE	Initial commit	2022-03-25 10:34:28 +01:00
README.md	set goals for 0.2.0 milestone	2022-04-04 23:00:37 +02:00
orcli	set goals for 0.2.0 milestone	2022-04-04 23:00:37 +02:00

README.md

orcli (💎+🤖)

Bash script to control OpenRefine via its HTTP API.

Features

works with latest OpenRefine version (currently 3.5)
nested sub-commands with help screens and usage examples
batch processing (import, transform, export) with temporary workspaces; your existing OpenRefine data will not be touched
import CSV~~, TSV, line-based TXT, fixed-width TXT, JSON or XML~~ (and specify input options)
transform data by providing an undo/redo JSON file; orcli calls specific endpoints for each operation to provide improved error handling and logging
export to ~~CSV,~~ TSV~~, HTML, XLS, XLSX, ODS~~
~~templating export to additional formats like JSON or XML~~

Requirements

GNU/Linux with Bash
jq
curl

Install

Navigate to the OpenRefine program directory
Download bash script there and make it executable

wget https://github.com/opencultureconsulting/orcli/raw/main/orcli
chmod +x orcli

Create a symlink in your $PATH (e.g. to ~/.local/bin)

ln -s "${PWD}/orcli" ~/.local/bin/

Usage

Ensure you have OpenRefine running (i.e. available at http://localhost:3333 or another URL) or use the integrated start command first.

Use integrated help screens for available options and examples for each command.

$ orcli --help
orcli - OpenRefine command-line interface written in Bash

Usage:
  orcli [command]
  orcli [command] --help | -h
  orcli --version | -v

Commands:
  info   show project metadata
  list   list projects on OpenRefine server

Options:
  --help, -h
    Show this help

  --version, -v
    Show version number

Environment Variables:
  OPENREFINE_URL
    URL to OpenRefine server
    Default: http://localhost:3333

  OPENREFINE_CSRF
    set to false for OpenRefine < 3.3
    Default: true

Examples:
  orcli list
  orcli info clipboard
  orcli info 1234567890123

https://github.com/opencultureconsulting/orcli

Development

orcli uses bashly for generating the one-file script from files in the src directory

Install bashly (requires ruby)

gem install bashly

Edit code in src directory
Validate and generate script

bashly validate
bashly generate