# Install swag with Homebrew, zypper

Automatically generate RESTful API documentation with Swagger 2.0 for Go. Version 1.16.6 via Homebrew; verified 2026-07-26. Also installable with zypper: sudo zypper install swag.

## Install

```sh
sudo av install brew:swag
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install swag
```

  Evidence: local Homebrew formula metadata

### Linux

- zypper (92%):

```sh
sudo zypper install swag
```

  Evidence: openSUSE Tumbleweed package metadata: swag from https://download.opensuse.org/tumbleweed/repo/oss/repodata/50b07339cb64c8ed4091bdbabddadc1ff5737b090e478818a195b40d8a3292861a879139b4a3987c31109699fde9fbf4a716367ddf4eef77da75f96e3193d6ed-primary.xml.zst

## Package facts

- **Package key:** brew:swag
- **Package manager:** Homebrew
- **Version:** 1.16.6
- **Source summary:** Automatically generate RESTful API documentation with Swagger 2.0 for Go
- **Homepage:** <https://github.com/swaggo/swag>
- **Repository:** <https://github.com/swaggo/swag>
- **Last updated:** 2026-07-26T04:03:48+02:00
- **Generated:** 2026-08-03T19:37:03+00:00

## Executables

- swag (alias)

## Install behavior

- Bottle: not available

## Freshness

- Page generated: 2026-08-03
- Package-manager version: 1.16.6
## 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

- <https://api.github.com/repos/swaggo/swag>
- <https://api.github.com/repos/swaggo/swag/releases>
- <https://github.com/swaggo/swag#readme>
- source_facts.package-manager


## Security Notes

narrow executable package without higher-risk signals.

- **Geiger risk:** green / low
- narrow executable package without higher-risk signals


## 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

- Unix: .swaggo
## Other Package-Manager Records

- zypper - swag - 1.16.6-1.7: normalized package name match | openSUSE Tumbleweed package metadata: swag from https://download.opensuse.org/tumbleweed/repo/oss/repodata/50b07339cb64c8ed4091bdbabddadc1ff5737b090e478818a195b40d8a3292861a879139b4a3987c31109699fde9fbf4a716367ddf4eef77da75f96e3193d6ed-primary.xml.zst | Automatically generate RESTful API documentation with Swagger 2.0 for Go | https://github.com/swaggo/swag


## Combined YAML source

View the package source record on GitHub. [combined/swag.yml](https://github.com/mxcl/pkgdb/blob/main/combined/swag.yml)


## Sources

- pkg.so package database
- Geiger risk classifier
- curated configuration and credential file locations
- curated package history
- pkgdb category and tag curation
- external package-manager database matches
- cross-ecosystem install command graph