Automic VaultAutomic Vault

brew

sourcedocs を Homebrew でインストール

sourcedocs のインストール経路、実行ファイル、メタデータ、AI エージェント向けセキュリティノートを確認します。

インストールコマンドセキュリティノート

インストール

追加のインストールコマンド

macOS

Homebrew確認済み · 100%
brew install sourcedocs

local Homebrew formula metadata

概要

パッケージ概要

Generate Markdown files from inline source code documentation

コマンドとエイリアス

  • sourcedocs

履歴

プロジェクトの歴史と使われ方

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.

リスク分類器

リスク グリーン · 信頼度 低 · appliance

理由

  • narrow executable package without higher-risk signals

信号

  • metadata:no-higher-risk-signals

インストール挙動

  • formula メタデータに Homebrew post-install フックは記録されていません。
  • Homebrew bottle メタデータは 8 個のプラットフォームターゲットで利用できます。

推奨レビュー

エージェントに無人実行させる前に、このツールが平文の認証情報を読むか、リモート状態を書き込むか、成果物を公開するか、プラグインを起動するかを確認してください。

実行可能ファイル

インストールされる実行可能ファイル

コマンド種類公開範囲メモ
sourcedocscliグローバル実行可能ファイル

鮮度

バージョンと鮮度

これらの信号は、ページ生成時期、パッケージマネージャの活動、上流リリース比較を分けて示します。バージョン遅れは、証拠 URL と比較可能なバージョンがある場合だけ警告されます。

ページ生成日2026-07-26
マネージャ版2.0.1
マネージャ更新日
ローカルデータOK
上流最新
検出された最新2.0.1

https://github.com/SourceDocs/SourceDocs

  • 情報No package-manager update timestamp was available.信頼度 低

インストールメタデータ

パッケージメタデータ

パッケージキーbrew:sourcedocs
バージョン2.0.1
パッケージマネージャHomebrew
パッケージマネージャページhttps://formulae.brew.sh/formula/sourcedocs
ホームページhttps://github.com/SourceDocs/SourceDocs
リポジトリhttps://github.com/SourceDocs/SourceDocs
上流ドキュメントhttps://github.com/SourceDocs/SourceDocs#readme
ライセンスMIT
ソースアーカイブhttps://github.com/SourceDocs/SourceDocs/archive/refs/tags/2.0.1.tar.gz
macOS 提供ライブラリswift
Bottle利用可能 (対象 arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, arm64_ventura, sonoma, ventura, x86_64_linux)
Homebrew post-install未定義
サービス宣言なし

レジストリ情報

ソースデータベース詳細

Source DatabaseHomebrew formula API
Taphomebrew/core
Full Namesourcedocs
Version Scheme0
Revision0
Requirements
  • xcode
Bottle Stable Root URLhttps://ghcr.io/v2/homebrew/core
Deprecatedno
Disabledno
Keg Onlyno
URL Keys
  • stable

パッケージグラフ

リンクは、ローカルのパッケージ関係グラフ、補足データ、依存関係、エコシステム一致、パッケージハブ所属から来ています。

同じワークフロー

  • helm-docsShares av.db curated category or tags: cli, developer-tools, documentation-generator, markdown.
  • nefShares av.db curated category or tags: cli, developer-tools, markdown, swift.
  • terraform-docsShares av.db curated category or tags: cli, developer-tools, documentation-generator, markdown.
  • action-docsShares av.db curated category or tags: cli, developer-tools, markdown.
  • adr-toolsShares av.db curated category or tags: cli, developer-tools, markdown.
  • baguetteShares av.db curated category or tags: cli, developer-tools, swift.

エージェント安全ガイド

ソース経路

リポジトリデータから生成

このページは scripts/generate-pkg-sqlite.py が生成した非公開のパッケージ SQLite アーティファクトから av-web によって提供されます。

使用ソース

  • 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