All Tools View Categories About Contact Privacy

Env Documentation Generator

Turn a .env into a documented table — key, type, required, default, purpose.

Runs entirely in your browser — nothing is uploaded.

About Env Documentation Generator

Every env variable deserves a line in the docs. The Env Documentation Generator produces that line — a table with key, inferred type, whether it is required, its default, and a purpose column — from a paste of your .env.

It is the documentation habit without the typing: keys, values, and comment hints are parsed, types are inferred heuristically (boolean, number, URL, JSON, string), and the result renders as Markdown or HTML, ready for your wiki, README, or internal reference.

A privacy toggle replaces real defaults with <redacted> when the docs will be shared broadly, and the table itself never leaves your browser.

Features

  • Per-key table: key, type, required, default, purpose.
  • Type inference: boolean, number, URL, JSON, string.
  • Required flags: driven by value presence.
  • Purpose column: carry over your # comments.
  • Markdown or HTML: output format choice.
  • Redact defaults: placeholders for public docs.
  • Copy or download: export the table.
  • Private: fully client-side.

How to Use

  1. Paste your .env into the input, or load the sample.
  2. Choose format (Markdown or HTML) and redaction.
  3. Click Generate. The table appears instantly.
  4. Copy it into your wiki or README.

Examples

Example 1 — Internal runbook. A service's config is documented in a markdown table so on-call engineers can find the purpose of a variable fast.

Example 2 — Public OSS README. Redaction enabled, the table ships in the README without leaking real defaults.

Example 3 — Onboarding doc. New developers get a generated table alongside the .env.example so every key has both a name and a purpose.

Example 4 — Config audit. A review generates the table and spots an undocumented legacy key by its missing purpose column.

Example 5 — Wiki page. A team pastes the HTML output directly into a Confluence-style wiki page.

Benefits

  • Zero typing: docs appear from the file itself.
  • Consistent schema: same columns every time.
  • Privacy-aware: redaction when needed.
  • Two formats: Markdown and HTML.
  • Type-aware: better than a plain list.
  • Private: nothing uploaded.

Frequently Asked Questions

What does this tool generate?
A table documenting every variable in your .env file, with columns for key, inferred type, required flag, default value, and a reason column you can fill in. Output is Markdown by default, with an HTML option.
How is &ldquo;required&rdquo; decided?
Empty values are marked required (the docs often omit a sensible default), while values already present are shown with their default. You can flip the toggle to treat present values as required too.
How is the type inferred?
Heuristically: true/false becomes boolean, a pure number becomes number, JSON-looking text stays JSON, a URL becomes URL, and everything else is string.
Can I include the real default values?
Yes, at cost: the generated docs will contain your config values. A toggle replaces defaults with placeholders when the docs are meant for public sharing.
Is anything uploaded?
No. Table generation is a client-side transformation of the text you paste.