agentleFS
Sign inStart free
KotlinKotlin/dataframe/dataframe-excel/AGENTS.md

dataframe / dataframe-excel

AGENTS.md1.1k starsChanged 26 days agoApache-2.0View on GitHub

Guidance for this module. See the root AGENTS.md for repo-wide build/style/KoDEx rules; only module-specific details are here. dataframe-excel (artifact dataframe-excel, "Excel support for Kotlin DataFrame"). Reads and writes .xls and .xlsx spreadsheets to/from DataFrame, built on Apache POI (poi exposed as api, poi-ooxml as implementation). Depends on core and, as api, on dataframe-json — JSON is used to write nested DataFrame/DataRow values into Excel cells. That JSON dependency can be excluded downstream if you only write flat frames. The whole…

Trending

Less talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 3 mentionsJun 2026: 8 mentionsJul 2026: 7 mentionsAug 2026: 6 mentionsSep 2026: 6 mentionsOct 2026: 12 mentionsNov 2026: 1 mention
Dec 2025Jun 2026Nov 2026
Mentions a month of the Kotlin/dataframe repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about Kotlin/dataframe

The biggest 5 of 51 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 51

Talked about on GitHub and Bluesky (51 times).

On GitHub · 50

45 more on GitHub

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run just this module: ./gradlew dataframe-excel:test (add -Pkotlin.dataframe.debug=true to match CI checks).

    line 36

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md — dataframe-excel

Guidance for this module. See the root AGENTS.md for repo-wide build/style/KoDEx rules; only module-specific details are here.

What this module is

dataframe-excel (artifact dataframe-excel, "Excel support for Kotlin DataFrame"). Reads and writes .xls and .xlsx spreadsheets to/from DataFrame, built on Apache POI (poi exposed as api, poi-ooxml as implementation).

Depends on core and, as api, on dataframe-json — JSON is used to write nested DataFrame/DataRow values into Excel cells. That JSON dependency can be excluded downstream if you only write flat frames.

Public API surface (src/main/kotlin/.../io/xlsx.kt)

The whole public API is one file, xlsx.kt:

  • DataFrame.Companion.readExcel(...) — many overloads over the input source (String path/URL, File, URL, InputStream, an already-open POI Workbook, or a single Sheet). Common parameters: sheetName, skipRows, columns (Excel-style column range like "A:C"), stringColumns, rowsCount, nameRepairStrategy, firstRowIsHeader, formattingOptions, parseEmptyAsNull.
  • FormattingOptions / StringColumns.toFormattingOptions(...) — force specific columns to be read as strings using a POI DataFormatter (useful for zip codes, IDs, etc. that shouldn't be parsed as numbers).
  • DataFrame<T>.writeExcel(...) — writes to String path / File; parameters include columnsSelector, sheetName, writeHeader, workBookType (WorkBookType.XLS / WorkBookType.XLSX, default XLSX), and keepFile (append a new sheet to an existing workbook instead of overwriting).

Legacy/deprecated: xlsx.kt also defines Excel, an implementation of the old SupportedDataFrameFormat SPI registered in src/main/resources/META-INF/services/org.jetbrains.kotlinx.dataframe.io.SupportedFormat. That SPI is deprecated (ERROR level, removed in 1.0) — don't build on it; readExcel/writeExcel are the real API.

Tests

  • Tests under src/test/kotlin/.../io/; spreadsheet fixtures in src/test/resources/.
  • Run just this module: ./gradlew dataframe-excel:test (add -Pkotlin.dataframe.debug=true to match CI checks).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free