# 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
- **ホームページ:** <https://github.com/SourceDocs/SourceDocs>
- **リポジトリ:** <https://github.com/SourceDocs/SourceDocs>
- **生成日時:** 2026-08-03T19:37:03+00:00

## 実行可能ファイル

- sourcedocs (エイリアス)

## インストール挙動

- Bottle: 利用不可

## バージョンと鮮度

- ページ生成日: 2026-08-03
- マネージャ版: 2.0.1
## プロジェクトの歴史と使われ方

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.

### ソース

- <https://github.com/SourceDocs/SourceDocs#readme>
- <https://github.com/SourceDocs/SourceDocs/blob/master/CHANGELOG.md>
- <https://github.com/SourceDocs/SourceDocs/releases>


## セキュリティノート

narrow executable package without higher-risk signals.

- **Geiger リスク:** グリーン / 低
- narrow executable package without higher-risk signals


## 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
- curated package history
- pkgdb category and tag curation
- cross-ecosystem install command graph
