# j > CLI tool for working with spreadsheet files Latest version **1.0.0** (published 2017-12-05) · Apache-2.0 license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install j pnpm add j yarn add j bun add j ``` Provides the command `j`. ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2017-12-05 | | First published | 2013-12-06 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.8 | | Dependencies | 4 | | Known vulnerabilities | 0 (+2 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 353 | | Author | sheetjs | | Maintainers | sheetjs | | Keywords | excel, xls, xlsx, xlsm, xlsb, ods, dif, csv, sylk, prn, ods, dbf, office, spreadsheet | ## Links - npm: https://www.npmjs.com/package/j - Repository: https://github.com/SheetJS/j - Homepage: https://github.com/SheetJS/j#readme - Issues: https://github.com/SheetJS/j/issues - npm.io page: https://npm.io/package/j ## Dependencies (4) - [xlsx](https://npm.io/package/xlsx.md) - [commander](https://npm.io/package/commander.md) - [concat-stream](https://npm.io/package/concat-stream.md) - [exit-on-epipe](https://npm.io/package/exit-on-epipe.md) ## Alternatives - [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads - [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads - [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads - [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads - [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads ## Recent versions - 1.0.0 (latest) — 2017-12-05 - 0.4.5 — 2017-03-11 - 0.4.4 — 2017-03-04 - 0.4.3 — 2014-10-10 - 0.4.2 — 2014-10-03 - 0.4.1 — 2014-10-02 - 0.4.0 — 2014-10-02 - 0.3.15 — 2014-10-01 - 0.3.14 — 2014-09-05 - 0.3.13 — 2014-08-26 - 0.3.12 — 2014-08-23 - 0.3.11 — 2014-07-29 - 0.3.10 — 2014-07-15 - 0.3.9 — 2014-07-10 - 0.3.8 — 2014-07-04 - … 34 more at https://npm.io/package/j/versions ## README # J NOTE: this library / tool is a relic from a time when the SheetJS Spreadsheet Parsing and Writing libraries were separate entities. They have been unified in the [js-xlsx project](https://git.io/xlsx), [`xlsx` on NPM](http://npm.im/xlsx). New projects should be using that library directly. Simple data wrapper that attempts to wrap SheetJS libraries to provide a uniform way to access data from Excel and other spreadsheet files: - JS-XLSX: [`xlsx` on NPM](http://npm.im/xlsx) - JS-XLS: [`xlsjs` on NPM](http://npm.im/xlsjs) - JS-HARB: [`harb` on NPM](http://npm.im/harb) Excel files are parsed based on the content (not by extension). For example, CSV files can be renamed to .XLS and excel will do the right thing. Supported Formats: | Format | Read | Write | |:-------------------------------------------------------------|:-----:|:-----:| | **Excel Worksheet/Workbook Formats** |:-----:|:-----:| | Excel 2007+ XML Formats (XLSX/XLSM) | :o: | :o: | | Excel 2007+ Binary Format (XLSB BIFF12) | :o: | :o: | | Excel 2003-2004 XML Format (XML "SpreadsheetML") | :o: | :o: | | Excel 97-2004 (XLS BIFF8) | :o: | :o: | | Excel 5.0/95 (XLS BIFF5) | :o: | :o: | | Excel 4.0 (XLS/XLW BIFF4) | :o: | | | Excel 3.0 (XLS BIFF3) | :o: | | | Excel 2.0/2.1 (XLS BIFF2) | :o: | :o: | | **Excel Supported Text Formats** |:-----:|:-----:| | Delimiter-Separated Values (CSV/TXT) | :o: | :o: | | Data Interchange Format (DIF) | :o: | :o: | | Symbolic Link (SYLK/SLK) | :o: | :o: | | Lotus Formatted Text (PRN) | :o: | :o: | | UTF-16 Unicode Text (TXT) | :o: | :o: | | **Other Workbook/Worksheet Formats** |:-----:|:-----:| | OpenDocument Spreadsheet (ODS) | :o: | :o: | | Flat XML ODF Spreadsheet (FODS) | :o: | :o: | | Uniform Office Format Spreadsheet (标文通 UOS1/UOS2) | :o: | | | dBASE II/III/IV / Visual FoxPro (DBF) | :o: | :o: | | Lotus 1-2-3 (WKS/WK1/WK2/WK3/WK4/123) | :o: | | | Quattro Pro Spreadsheet (WQ1/WQ2/WB1/WB2/WB3/QPW) | :o: | | | **Other Common Spreadsheet Output Formats** |:-----:|:-----:| | HTML Tables | :o: | :o: | | Rich Text Format tables (RTF) | | :o: | | Ethercalc Record Format (ETH) | :o: | :o: | | Markdown Tables | | :o: | | XML Data (XML) | | :o: | ![circo graph of format support](formats.png) ## Installation ```bash $ npm install -g j ``` ## Node Library ```js var J = require('j'); ``` `J.readFile(filename)` opens file specified by `filename` and returns an array whose first object is the parsing object (XLS or XLSX) and whose second object is the parsed file. `J.utils` has various helpers that expect an array like those from `readFile`: | Format | utility function | |:---------------------------------------------------------|:------------------| | Excel 2007+ XML Formats (XLSX/XLSM) | `to_xlsx/to_xlsm` | | Excel 2007+ Binary Format (XLSB BIFF12) | `to_xlsb` | | Excel 2.0/2.1 (XLS BIFF2) | `to_biff2` | | Delimiter-Separated Values (CSV/TSV/DSV) | `to_csv/to_dsv` | | Data Interchange Format (DIF) | `to_dif` | | Symbolic Link (SYLK/SLK) | `to_sylk` | | OpenDocument Spreadsheet (ODS) | `to_ods` | | Flat XML ODF Spreadsheet (FODS) | `to_fods` | | HTML Tables | `to_html` | | Markdown Tables | `to_md` | | XML Data (XML) | `to_xml` | | Ethercalc Record Format (ETH) | `to_socialcalc` | | JSON Row Objects | `to_json` | | List of Formulae | `to_formulae` | ## CLI Tool The node module ships with a binary `j` which has a help message: ``` $ j --help Usage: j.njs [options] [sheetname] Options: -h, --help output usage information -V, --version output the version number -f, --file use specified workbook (- for stdin) -s, --sheet print specified sheet (default first sheet) -N, --sheet-index use specified sheet index (0-based) -p, --password if file is encrypted, try with specified pw -l, --list-sheets list sheet names and exit -o, --output output to specified file -B, --xlsb emit XLSB to or .xlsb -M, --xlsm emit XLSM to or .xlsm -X, --xlsx emit XLSX to or .xlsx -Y, --ods emit ODS to or .ods -8, --xls emit XLS to or .xls (BIFF8) -5, --biff5 emit XLS to or .xls (BIFF5) -2, --biff2 emit XLS to or .xls (BIFF2) -6, --xlml emit SSML to or .xls (2003 XML) -T, --fods emit FODS to or .fods (Flat ODS) -S, --formulae emit list of values and formulae -j, --json emit formatted JSON (all fields text) -J, --raw-js emit raw JS object (raw numbers) -A, --arrays emit rows as JS objects (raw numbers) -H, --html emit HTML to or .html -D, --dif emit DIF to or .dif (Lotus DIF) -U, --dbf emit DBF to or .dbf (MSVFP DBF) -K, --sylk emit SYLK to or .slk (Excel SYLK) -P, --prn emit PRN to or .prn (Lotus PRN) -E, --eth emit ETH to or .eth (Ethercalc) -t, --txt emit TXT to or .txt (UTF-8 TSV) -r, --rtf emit RTF to or .txt (Table RTF) -x, --xml emit XML -m, --markdown emit markdown table -F, --field-sep CSV field separator -R, --row-sep CSV row separator -n, --sheet-rows Number of rows to process (0=all rows) --sst generate shared string table for XLS* formats --compress use compression when writing XLSX/M/B and ODS --read read but do not generate output --all parse everything; write as much as possible --dev development mode -q, --quiet quiet mode ``` ## License Please consult the attached LICENSE file for details. All rights not explicitly granted by the Apache 2.0 license are reserved by the Original Author. [![Build Status](https://travis-ci.org/SheetJS/j.svg?branch=master)](https://travis-ci.org/SheetJS/j) [![Coverage Status](http://img.shields.io/coveralls/SheetJS/j/master.svg)](https://coveralls.io/r/SheetJS/j?branch=master) [![NPM Downloads](https://img.shields.io/npm/dt/j.svg)](https://npmjs.org/package/j) [![Dependencies Status](https://david-dm.org/sheetjs/j/status.svg)](https://david-dm.org/sheetjs/j) [![ghit.me](https://ghit.me/badge.svg?repo=sheetjs/js-xlsx)](https://ghit.me/repo/sheetjs/js-xlsx) [![Analytics](https://ga-beacon.appspot.com/UA-36810333-1/SheetJS/j?pixel)](https://github.com/SheetJS/j) ## Using J for diffing spreadsheet files Using `git textconv`, you can use `J` to generate more meaningful diffs! One-time configuration (`misc/gitdiff.sh`): ``` #!/bin/bash # Define a sheetjs diff type that uses j git config --global diff.sheetjs.textconv "j" # Configure a user .gitattributes file that maps the xls{,x,m} files touch ~/.gitattributes cat <>~/.gitattributes *.xls diff=sheetjs *.xlsb diff=sheetjs *.xlsm diff=sheetjs *.xlsx diff=sheetjs *.XLS diff=sheetjs *.XLSB diff=sheetjs *.XLSM diff=sheetjs *.XLSX diff=sheetjs EOF # Set the .gitattributes to be used for all repos on the system: git config --global core.attributesfile '~/.gitattributes' ``` If you just want to compare formulae (for example, in a sheet using `NOW`): ``` git config --global diff.sheetjs.textconv "j -S" ``` NOTE: There are some known issues regarding global modules in Windows. The best bet is to `npm install j` in your git directory before diffing. --- _Source: https://npm.io/package/j · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._