macOS
Homebrewverifiziert · 100%
brew install naturaldocslocal Homebrew formula metadata
MacPortsverifiziert · 94%
sudo port install naturaldocsMacPorts ports tree · textproc/naturaldocs/Portfile · Quelle: api.github.com
brew
naturaldocs mit Homebrew, apt, MacPorts, dnf installieren
Prüfe Installationswege, Executables, Metadaten und Sicherheitshinweise für naturaldocs in AI-Agent-Workflows.
Installation
Weitere Installationsbefehle
Linux
Debian aptverifiziert · 92%
sudo apt install naturaldocsDebian stable package indexes · naturaldocs · Quelle: deb.debian.org
Fedora dnfverifiziert · 92%
sudo dnf install NaturalDocsFedora Rawhide package metadata · NaturalDocs · Quelle: dl.fedoraproject.org
Überblick
Paketzusammenfassung
Extensible, multi-language documentation generator
Projektlinks
Befehle und Aliase
- naturaldocs
Verlauf
Projektgeschichte und Nutzung
Natural Docs is a multi-language source-code documentation generator built around comments that stay readable in the source file. Its niche is documentation that feels closer to prose than annotation syntax, while still producing browsable HTML output.
Projektgeschichte
The official About page says Greg Valure wrote Natural Docs after rejecting heavier documentation workflows, open sourced it, and has maintained it since its first release in 2003. The same page records the major architectural shift from the original Perl implementation to Natural Docs 2.0, a C# rewrite with a new engine.
The GitHub repository for the 2.x code was created on 2017-04-17. Public GitHub releases include Natural Docs 2.3 on 2023-09-12, 2.3.1 on 2025-02-01, and 2.4 beta work in 2026.
Adoptionsgeschichte
Natural Docs has a long tail rather than a large modern package-manager footprint. The official site says it is used by educational institutions, government, companies, and individuals, and points to public pages generated by Natural Docs as evidence. Homebrew analytics consulted on 2026-07-01 listed 113 installs over the preceding 365 days.
Wie es verwendet wird
Users configure a project with `Project.txt`, which tells Natural Docs which source folders to scan, where to write generated documentation, and project metadata such as title. The reference documentation says command-line options can override parts of Project.txt, partly for compatibility with Natural Docs 1.x workflows.
Warum Paket-Nerds sich dafür interessieren
Natural Docs is interesting to package maintainers because it spans two eras of language tooling: old Perl-era source documentation and the 2.x C#/Mono packaging story. The Homebrew formula still depends on Mono, which makes it a reminder that documentation generators often carry runtime packaging constraints long after their core idea stabilizes.
Zeitleiste
- 2003: First Natural Docs release, according to the official About page.
- 2015-05-04: Natural Docs 2.0 development release tag appears in the GitHub repository.
- 2017-04-17: GitHub repository created for the 2.x source tree.
- 2023-09-12: Natural Docs 2.3 released.
- 2025-02-01: Natural Docs 2.3.1 released.
- 2026-05-26: Natural Docs 2.4 Beta 1 released as a prerelease.
Related projects
- Comparable documentation generators include Doxygen, Javadoc-style tooling, Sphinx, and language-native documentation systems, but Natural Docs' distinguishing feature is its plain-English comment style.
Quellen
Sicherheitslage
Risikostufe: grün
narrow executable package without higher-risk signals.
Risikoklassifikator
grün Risiko · niedrig Konfidenz · appliance
Warum
- narrow executable package without higher-risk signals
Signale
- metadata:no-higher-risk-signals
Installationsverhalten
- In den Formelmetadaten ist kein Homebrew-Post-install-Hook erfasst.
- Homebrew-Bottle-Metadaten sind für 1 Plattformziele verfügbar.
- Installiert mit 1 Laufzeitabhängigkeiten.
Empfohlene Prüfung
Prüfe vor unbeaufsichtigter Agent-Nutzung, ob das Tool Klartext-Credentials liest, Remote-Zustand schreibt, Artefakte veröffentlicht oder Plugins ausführt.
local files
Configuration and credential file locations
These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.
Configuration files
Config paths the tool may read or write during local use.
- Unix
Project.txt in the project configuration folder
Executables
Installierte Executables
| Befehl | Art | Sichtbarkeit | Hinweis |
|---|---|---|---|
naturaldocs | cli | globales Executable |
Aktualität
Version und Aktualität
Diese Signale trennen das Alter der Seitengenerierung, Aktivität des Paketmanagers und Upstream-Release-Vergleich. Versionsrückstand wird nur gemeldet, wenn eine Evidenz-URL und vergleichbare Versionen vorhanden sind.
Seite generiert2026-07-26
Manager-Version2.3.1
Manager aktualisiert
lokale DatenOK
Upstreamnot checked
neueste erkannte Versionnicht erkannt
- InfoNo package-manager update timestamp was available.niedrig Konfidenz
- InfoRelease/tag comparison is only available for GitHub repositories.https://www.naturaldocs.org/none Konfidenz
Installationsmetadaten
Paketmetadaten
| Paketschlüssel | brew:naturaldocs |
|---|---|
| Version | 2.3.1 |
| Paketmanager | Homebrew |
| Paketmanager-Seite | https://formulae.brew.sh/formula/naturaldocs |
| Homepage | https://www.naturaldocs.org/ |
| Repository | https://github.com/NaturalDocs/NaturalDocs |
| Upstream-Dokumentation | https://www.naturaldocs.org/getting_started |
| Lizenz | AGPL-3.0-only |
| Quellarchiv | https://downloads.sourceforge.net/project/naturaldocs/Stable%20Releases/2.3.1/Natural_Docs_2.3.1.zip |
| Abhängigkeiten | mono |
| Bottle | verfügbar (auf all) |
| Homebrew post-install | nicht definiert |
| Dienst | keiner deklariert |
Registry-Fakten
Details aus der Quelldatenbank
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | naturaldocs |
| Version Scheme | 0 |
| Revision | 0 |
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
Source-Datenbank-Treffer
Andere Paketmanager-Einträge
Treffer stammen aus externen Paketmanager-Indizes und bleiben von lokalen Automic-Vault-Paketlinks getrennt.
Debian apt95%
naturaldocs 1.51-4
extensible, multi-language documentation generator
sudo apt install naturaldocs- Section: devel
- Architecture: all
- 1 Abhängigkeiten
- normalized package name match
- Abgeglichen nach: Naturaldocs
Ubuntu apt95%
naturaldocs 1:1.5.1-0ubuntu1
an extensible, multi-language documentation generator
sudo apt install naturaldocs- Section: universe/devel
- Architecture: all
- 1 Abhängigkeiten
- normalized package name match
- Abgeglichen nach: Naturaldocs
dnf95%
NaturalDocs 1.52-36.fc44
Documentation generator for multiple programming languages
sudo dnf install NaturalDocs- License: GPL-2.0-or-later
- Category: Unspecified
- Architecture: noarch
- Source Package: NaturalDocs
- 3 Abhängigkeiten
- 3 stellt bereit
- normalized package name match
- Abgeglichen nach: Naturaldocs
MacPorts95%
naturaldocs
sudo port install naturaldocs- normalized package name match
- Abgeglichen nach: Naturaldocs
Quellspur
Aus Repository-Daten generiert
Diese Seite wird von av-web aus dem privaten Paket-SQLite-Artefakt bereitgestellt, das scripts/generate-pkg-sqlite.py erstellt.
Combined YAML source
View the package source record on GitHub.
Verwendete Quellen
- Geiger risk classifier
- Nucleus package database
- av.db category and tag curation
- cross-ecosystem install command graph
- curated configuration and credential file locations
- curated package history
- external package-manager database matches
- package relationship graph
- package version freshness
- package-page enrichment