macOS
Homebrewverifiziert · 100%
brew install sourcedocslocal Homebrew formula metadata
brew
sourcedocs mit Homebrew installieren
Prüfe Installationswege, Executables, Metadaten und Sicherheitshinweise für sourcedocs in AI-Agent-Workflows.
Installation
Weitere Installationsbefehle
Überblick
Paketzusammenfassung
Generate Markdown files from inline source code documentation
Projektlinks
Befehle und Aliase
- sourcedocs
Verlauf
Projektgeschichte und Nutzung
SourceDocs is a Swift command-line documentation generator that writes Markdown reference documentation from inline source comments, targeting repositories that want docs to live beside their code.
Projektgeschichte
The GitHub repository was created in October 2017, with the changelog marking 0.1.0 as the initial release. Early releases refined output directories, Markdown generation, and command-line behavior.
The 1.0.0 release added `SourceDocsLib` so other Swift tools could generate documentation, required Swift 5.1 or higher, added a `package` command for Swift packages, and migrated to Swift Argument Parser. Later 1.x and 2.x releases tracked Swift, Xcode, and package-generation changes.
Adoptionsgeschichte
The README positions SourceDocs alongside Sphinx and Jazzy, but with a Markdown-in-repository model intended for GitHub, Bitbucket, and GitHub Pages workflows. It is distributed through Homebrew and source builds.
Wie es verwendet wird
Users run `sourcedocs generate` from a Swift package or Xcode project root. The tool can generate documentation for all Swift Package Manager modules, a named module, package descriptions, and reproducible docs.
Warum Paket-Nerds sich dafür interessieren
Package nerds care because SourceDocs treats generated API docs as versioned Markdown artifacts rather than as an external hosted site. That makes it fit package repositories, CI diffs, and lightweight documentation publishing.
Zeitleiste
- 2017: Repository created and 0.1.0 initial release published.
- 2017: 0.4.0 changed default output to `Documentation/Reference` and revised command-line handling.
- 2020: 1.0.0 added `SourceDocsLib`, Swift 5.1 requirement, Swift Package documentation, and Swift Argument Parser.
- 2020: 1.1.0 added all-module generation and reproducible docs.
- 2021: 2.0.0 updated for Xcode 13.
- 2022: 2.0.1 updated for Xcode 13.3 and Swift 5.6.
Related projects
- SourceDocs is conceptually related to Jazzy and Sphinx, both named in its README.
- SourceKitten is listed by SourceKitten as a project built with SourceKitten and SourceDocs uses Swift tooling to inspect source for documentation.
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 8 Plattformziele verfügbar.
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.
Executables
Installierte Executables
| Befehl | Art | Sichtbarkeit | Hinweis |
|---|---|---|---|
sourcedocs | 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.0.1
Manager aktualisiert
lokale DatenOK
Upstreamaktuell
neueste erkannte Version2.0.1
https://github.com/SourceDocs/SourceDocs
- InfoNo package-manager update timestamp was available.niedrig Konfidenz
Installationsmetadaten
Paketmetadaten
| Paketschlüssel | brew:sourcedocs |
|---|---|
| Version | 2.0.1 |
| Paketmanager | Homebrew |
| Paketmanager-Seite | https://formulae.brew.sh/formula/sourcedocs |
| Homepage | https://github.com/SourceDocs/SourceDocs |
| Repository | https://github.com/SourceDocs/SourceDocs |
| Upstream-Dokumentation | https://github.com/SourceDocs/SourceDocs#readme |
| Lizenz | MIT |
| Quellarchiv | https://github.com/SourceDocs/SourceDocs/archive/refs/tags/2.0.1.tar.gz |
| Von macOS bereitgestellte Bibliotheken | swift |
| Bottle | verfügbar (auf arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, arm64_ventura, sonoma, ventura, x86_64_linux) |
| Homebrew post-install | nicht definiert |
| Dienst | keiner deklariert |
Registry-Fakten
Details aus der Quelldatenbank
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | sourcedocs |
| Version Scheme | 0 |
| Revision | 0 |
| Requirements |
|
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
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 package history
- package relationship graph
- package version freshness
- package-page enrichment