orcli/src/bashly.yml

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 \\\\
      import csv "https://git.io/fj5hF" --projectName "duplicates" \\\\
      info "duplicates" \\\\
      export tsv "duplicates"

commands:
  - name: completions
    help: |-
      Generate bash completions
      Usage: eval "\$(orcli completions)"
  - name: batch
    help: start tmp OpenRefine workspace and run multiple orcli commands
    catch_all:
      label: orcli commands
      help: |-
        provide orcli commands without further separators (see examples below)
        avoid "import" "info" "list" "transform" "export" in file or project names
        use bash -c to execute custom commands
      required: 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: --quiet
        short: -q
        help: suppress log output, print errors only
    examples:
      - |-
        orcli batch \\\\
          import csv "https://git.io/fj5hF" --projectName "duplicates" \\\\
          info "duplicates" \\\\
          export tsv "duplicates"
      - |-
        orcli batch --memory "2000M" --port "3334" \\\\
          import csv "https://git.io/fj5hF" --projectName "duplicates" \\\\
          export tsv "duplicates"
      - |-
        orcli batch --quiet \\\\
          import csv "https://git.io/fj5hF" --projectName "duplicates" \\\\
          export tsv "duplicates" --output "output/duplicates.tsv" \\\\
          bash -c 'wc -l output/*; echo "finished" in \$SECONDS seconds'

  - 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
          - long: --quiet
            short: -q
            help: suppress log output, print errors only
        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
    flags:
      - long: --quiet
        short: -q
        help: suppress log output, print errors only

  - name: info
    help: show project metadata
    args:
      - name: project
        help: project name or id
        required: true
    flags:
      - long: --quiet
        short: -q
        help: suppress log output, print errors only
    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"
          - long: --quiet
            short: -q
            help: suppress log output, print errors only
        examples:
          - orcli export tsv "duplicates"
          - orcli export tsv "duplicates" --output "duplicates.tsv"