# sourcedocs を Homebrew でインストール sourcedocs のインストール経路、実行ファイル、メタデータ、AI エージェント向けセキュリティノートを確認します。 ## インストール ```sh sudo av install brew:sourcedocs ``` 追加のインストールコマンド: ### macOS - Homebrew (100%): ```sh brew install sourcedocs ``` 証拠: local Homebrew formula metadata ## パッケージ情報 - **パッケージキー:** brew:sourcedocs - **パッケージマネージャ:** Homebrew - **パッケージマネージャページ:** - **バージョン:** 2.0.1 - **ソース概要:** Generate Markdown files from inline source code documentation - **ホームページ:** - **リポジトリ:** - **ライセンス:** MIT - **ソースアーカイブ:** - **生成日時:** 2026-08-04T22:13:35+00:00 ## 実行可能ファイル - sourcedocs (cli) - sourcedocs (エイリアス) ## macOS 提供ライブラリ - swift ## インストール挙動 - post-install フック: 未定義 - Bottle: 利用可能 対象 arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, arm64_ventura, sonoma, ventura, x86_64_linux ## バージョンと鮮度 - ページ生成日: 2026-08-04 - マネージャ版: 2.0.1 - ローカルデータ: OK - 上流リポジトリ: https://github.com/SourceDocs/SourceDocs - 検出された最新: 2.0.1 (最新) - 情報: No package-manager update timestamp was available. ## プロジェクトの歴史と使われ方 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. ### プロジェクトの歴史 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. ### 採用の歴史 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. ### 使われ方 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. ### パッケージ好きにとっての重要性 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. ### タイムライン - 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. ### ソース - - - ## セキュリティノート narrow executable package without higher-risk signals. - **Geiger リスク:** グリーン / 低 - narrow executable package without higher-risk signals ## ソースデータベース詳細 - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** sourcedocs - **Version Scheme:** 0 - **Revision:** 0 - **Requirements:** xcode - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** stable ## 関連リンク - [Source-control packages](https://pkg.so/ja/source-control-tools/) - Belongs to a source-control command family. - [Terminal utility packages](https://pkg.so/ja/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://pkg.so/ja/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [Developer build packages](https://pkg.so/ja/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata. - [terraform-docs](https://pkg.so/ja/brew/terraform-docs/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation-generator, markdown. - [helm-docs](https://pkg.so/ja/brew/helm-docs/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation-generator, markdown. - [nef](https://pkg.so/ja/brew/nef/) - Shares pkgdb curated category or tags: cli, developer-tools, markdown, swift. - [xcbeautify](https://pkg.so/ja/brew/xcbeautify/) - Shares pkgdb curated category or tags: cli, developer-tools, swift. - [swiftlint](https://pkg.so/ja/brew/swiftlint/) - Shares pkgdb curated category or tags: cli, developer-tools, swift. - [pandoc](https://pkg.so/ja/brew/pandoc/) - Shares pkgdb curated category or tags: cli, developer-tools, markdown. - [mint](https://pkg.so/ja/brew/mint/) - Shares pkgdb curated category or tags: cli, developer-tools, swift. - [xcodegen](https://pkg.so/ja/brew/xcodegen/) - Shares pkgdb curated category or tags: cli, developer-tools, swift. - [dashing](https://pkg.so/ja/brew/dashing/) - Local metadata places this package in an adjacent workflow. Shared terms: cli, developer, developer-tools, documentation, documentation-generator. - [get-llms-txt](https://pkg.so/ja/npm/get-llms-txt/) - Both packages work with overlapping file formats or content types. Shared terms: cli, developer, developer-tools, documentation, files. ## Combined YAML source View the package source record on GitHub. [combined/sourcedocs.yml](https://github.com/mxcl/pkgdb/blob/main/combined/sourcedocs.yml) ## ソース - pkg.so package database - Geiger risk classifier - package-page enrichment - curated package history - package version freshness - pkgdb category and tag curation - package relationship graph - cross-ecosystem install command graph