macOS
Homebrewverified · 100%
brew install swaglocal Homebrew formula metadata
brew
Install swag with Homebrew, zypper
Automatically generate RESTful API documentation with Swagger 2.0 for Go. Version 1.16.6 via Homebrew; verified from local package data.
install
Additional install commands
Linux
openSUSE zypperverified · 92%
sudo zypper install swagopenSUSE Tumbleweed package metadata · swag · source: download.opensuse.org
overview
Package summary
Automatically generate RESTful API documentation with Swagger 2.0 for Go
Project links
Commands and aliases
- swag
history
Project history and usage
swag is the Swaggo command-line generator for producing Swagger 2.0 documentation from Go source-code annotations. It became a common Go ecosystem tool because it lets web services generate API docs without leaving the Go build and source layout.
Project history
The swaggo/swag repository was created on GitHub in June 2017. Its README says Swag converts Go annotations to Swagger Documentation 2.0 and provides plugins for popular Go web frameworks so generated output can be served through Swagger UI.
Adoption history
The project reached a v1.0.0 release in November 2017 and continued through the v1.x line while publishing binaries, a Docker image, and `go install` instructions. The README lists integrations for Gin, Echo, Buffalo, net/http, gorilla/mux, chi, Fiber, Hertz, and other Go web stacks.
How it is used
The standard workflow is to add declarative comments to Go handlers, install the `swag` command, and run `swag init` at the project root. The CLI then writes a docs package plus swagger.json and swagger.yaml outputs, with flags for alternate entry files, output directories, parse depth, dependency parsing, and global overrides via `.swaggo`.
Why package nerds care
swag is package-nerd relevant because it turns API documentation generation into a reproducible build step for Go projects. Distributions and developer package managers care about it as a standalone CLI, while Go users care that the same tool can be installed as a binary, Docker image, or module-aware `go install` target.
Timeline
- 2017: GitHub repository created.
- 2017: v1.0.0 tag published.
- 2025: v1.16.6 released in the continuing v1 line.
- 2026: v2.0.0 release candidates listed in GitHub releases during research.
Related projects
- The README points to companion Swagger UI middleware packages such as swaggo/gin-swagger, swaggo/echo-swagger, swaggo/files, and swaggo/http-swagger.
Sources
security posture
Risk level: green
narrow executable package without higher-risk signals.
Risk classifier
green risk · low confidence · appliance
Why
- narrow executable package without higher-risk signals
Signals
- metadata:no-higher-risk-signals
Install behavior
- No Homebrew post-install hook is recorded in formula metadata.
- Homebrew bottle metadata is available for 6 platform targets.
- Build metadata lists 1 build dependencies.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
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
.swaggo
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
swag | cli | global executable |
freshness
Version and freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
page generated2026-07-08
manager version1.16.6
manager updated
local dataok
upstreamcurrent
latest detectedv1.16.6
https://github.com/swaggo/swag
- infoNo package-manager update timestamp was available.low confidence
install metadata
Package metadata
| Package key | brew:swag |
|---|---|
| Version | 1.16.6 |
| Package manager | Homebrew |
| Package manager page | https://formulae.brew.sh/formula/swag |
| Homepage | https://github.com/swaggo/swag |
| Repository | https://github.com/swaggo/swag |
| Upstream docs | https://github.com/swaggo/swag#readme |
| License | MIT |
| Source archive | https://github.com/swaggo/swag/archive/refs/tags/v1.16.6.tar.gz |
| Build dependencies | go |
| Bottle | available (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux) |
| Homebrew post-install | not defined |
| Service | none declared |
registry facts
Source database details
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | swag |
| Version Scheme | 0 |
| Revision | 0 |
| Head Version | HEAD |
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
source database matches
Other package-manager records
Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.
zypper95%
swag 1.16.6-1.4
Automatically generate RESTful API documentation with Swagger 2.0 for Go
https://github.com/swaggo/swag
sudo zypper install swag- License: MIT
- Category: Unspecified
- Architecture: x86_64
- Source Package: swag
- 1 dependencies
- 1 provides
- normalized package name match
- Matched by: Swag
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- 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