excel2adoc CLI

A CLI that prints .xlsx or .csv file(s) into their asciidoc representation on stdout

User guide

$ excel2adoc -h

Usage: excel2adoc [-hntV] [-s=2] <inputFiles>...
Prints .xlsx or .csv file(s) into their asciidoc representation on stdout
      <inputFiles>...   One or more .xlsx or .csv file(s) to print to stdout
  -h, --help            Show this help message and exit.
  -n, --no-headers      Disables interpretation of first row as header
                          Default: false
  -s, --sheet=2         Sheet number, starting at 1. if not provided, it will
                          try to print all sheets for all files
  -t, --no-titles       Disables table title using file name and sheet name (or
                          just file name for .csv)
                          Default: false
  -V, --version         Print version information and exit.

Releases

The binaries (linux, macOS and windows) can be found on this project release page

Why?

Because we all know product managers, project managers, timetable reporters that only swear by Excel to provide us with some insightful piece of information.

Let’s get real: if we want it to work, we use documentation as code, not binaries.

Here is a CLI tool to convert to the real deal, text. Just text, that will find all its use under a proper CVS.

How does it work?

This project uses Quarkus, the Supersonic Subatomic Framework, Apache POI, Kotlin and picocli (Quarkus picocli extension).

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./mvnw compile quarkus:dev

Packaging and running the application

The application can be packaged using:

./mvnw package

It produces the excel2adoc-1.0-runner.jar file in the /target directory. Be aware that it’s not an über-jar as the dependencies are copied into the target/lib directory.

If you want to build an über-jar, execute the following command:

./mvnw package -Dquarkus.package.type=uber-jar

The application is now runnable using java -jar target/excel2adoc-1.0-runner.jar.

Creating a native executable

You can create a native executable using:

./mvnw package -Pnative

Or, if you don’t have GraalVM installed, you can run the native executable build in a container using:

./mvnw package -Pnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/excel2adoc-1.0-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.html