All Tools View Categories About Contact Privacy

README / Setup Generator

Generate a README with install steps from pasted manifests.

Runs entirely in your browser - nothing is uploaded and no cluster connection is made.
Your generated README will appear here.

About README / Setup Generator

Hand-written setup docs go stale fast. The README / Setup Generator turns a set of pasted Kubernetes manifests into a Markdown README: a resource table, a copy-paste kubectl apply command, and a short list of setup notes.

Paste one or many manifests (separated by ---). Everything runs locally; nothing is uploaded.

Features

  • Resource table - kind, name, namespace.
  • Install command - kubectl apply -f.
  • Notes - short setup checklist.
  • Multi-doc - handles many manifests at once.
  • Copy / Download / Print - export the README.

How to Use

  1. Paste your manifests.
  2. Generate the README.
  3. Save it as README.md and deploy.

Examples

Example 1 - app. Deployment + Service become a table plus kubectl apply.

Example 2 - multi-ns. notes that resources span namespaces.

Benefits

  • Docs that match - generated from real manifests.
  • Onboarding - clear deploy steps.
  • Local - nothing uploaded.
  • Exportable - copy, download or print.

Frequently Asked Questions

What does it produce?
A Markdown README that lists every resource (kind, name, namespace) in a table, gives a kubectl apply command, and adds a short setup-notes section.
How do I use the output?
Save it as README.md next to your manifests, then run the printed kubectl apply -f command to deploy.
Does it group by namespace?
It lists each resource with its namespace (defaulting to "default") and notes when resources span multiple namespaces.
Does this connect to a cluster?
No. Manifests are parsed locally; nothing is uploaded.