Homebrew Ruby API

Alphabetic Index

File Listing

README

Namespace Listing A-Z

Top Level Namespace

API (Homebrew)
API (GitHub)
APIHashable
AST (Utils)
AST (RuboCop::Cask)
AST (RuboCop)
AbstractArtifact (Cask::Artifact)
AbstractCaskErrorWithToken (Cask)
AbstractContentLoader (Cask::CaskLoader)
AbstractDownloadStrategy
AbstractFileDownloadStrategy
AbstractFlightBlock (Cask::Artifact)
AbstractUninstall (Cask::Artifact)
Actions (GitHub)
Air (UnpackStrategy)
AliasAPILoader (Formulary)
AliasLoader (Formulary)
AlphaToken (Version)
AlreadyLinkedError (Keg)
Analytics (Utils)
Analytics (Homebrew::API)
Annotation (GitHub::Actions)
Apache (Homebrew::Livecheck::Strategy)
App (Cask::Artifact)
ArchRequirement
Args (Homebrew::CLI)
Array
Artifact (Cask::Artifact)
Artifact (Cask)
ArtifactSet (Cask)
AssertStatements (RuboCop::Cop::FormulaAudit)
Assertions (Homebrew)
Attr
AudioUnitPlugin (Cask::Artifact)
Audit (Cask)
Auditor (Cask)
AuthenticationFailedError (GitHub::API)

Base (Cask::DSL)
Bazaar (UnpackStrategy)
BazaarDownloadStrategy
BetaToken (Version)
Binary (Cask::Artifact)
Bitbucket (Homebrew::Livecheck::Strategy)
BlockDSL (Cask::URL)
Bom (UnpackStrategy::Dmg)
Bottle
BottleDigestIndentation (RuboCop::Cop::FormulaAudit)
BottleFormat (RuboCop::Cop::FormulaAudit)
BottleFormulaUnavailableError
BottleLoader (Formulary)
BottleOrder (RuboCop::Cop::FormulaAudit)
BottleSpecification
BottleTagIndentation (RuboCop::Cop::FormulaAudit)
Bottles (Utils)
Build
BuildEnvironment
BuildError
BuildFlagsError
BuildOptions
BundleVersion (Homebrew)
Bzip2 (UnpackStrategy)

CLI (Homebrew)
CLT (OS::Mac)
CLTSDKLocator (OS::Mac)
CPU (Hardware)
CVSDownloadStrategy
Cab (UnpackStrategy)
Cachable
Cache (Cask)
CacheStore
CacheStoreDatabase
CannotInstallFormulaError
Cask (Cask)
Cask (Homebrew::API)
Cask
Cask (RuboCop::Cop)
Cask (RuboCop)
CaskAlreadyCreatedError (Cask)
CaskAlreadyInstalledError (Cask)
CaskBlock (RuboCop::Cask::AST)
CaskConflictError (Cask)
CaskCyclicDependencyError (Cask)
CaskDependent
CaskDescriptionCacheStore
CaskError (Cask)
CaskHeader (RuboCop::Cask::AST)
CaskHelp (RuboCop::Cop::Cask)
CaskInvalidError (Cask)
CaskLoader (Cask)
CaskLock
CaskNotInstalledError (Cask)
CaskQuarantineError (Cask)
CaskQuarantinePropagationError (Cask)
CaskQuarantineReleaseError (Cask)
CaskSelfReferencingDependencyError (Cask)
CaskTokenMismatchError (Cask)
CaskUnavailableError (Cask)
CaskUnreadableError (Cask)
CaskUnspecifiedError (Cask)
Caskroom (Cask)
Caveats
Caveats (Cask::DSL)
Caveats (RuboCop::Cop::FormulaAudit)
Checks (Homebrew::Diagnostic)
Checksum
Checksum (RuboCop::Cop::FormulaAudit)
ChecksumCase (RuboCop::Cop::FormulaAudit)
ChecksumMismatchError
ChecksumMissingError
ChildProcessError
ClassInheritance (RuboCop::Cop::FormulaAudit)
ClassName (RuboCop::Cop::FormulaAudit)
Cleaner
Cleanup (Homebrew)
CodesignRequirement
Collector (Utils::Bottles)
Colorpicker (Cask::Artifact)
Commands
Comments (RuboCop::Cop::FormulaAudit)
Compiler (CompilerSelector)
CompilerFailure
CompilerSelectionError
CompilerSelector
Completions (Homebrew)
ComponentsOrder (RuboCop::Cop::FormulaAudit)
ComponentsRedundancy (RuboCop::Cop::FormulaAudit)
CompositeToken (Version)
Compress (UnpackStrategy)
Config (Cask)
ConflictError (Keg)
Conflicts (RuboCop::Cop::FormulaAudit)
ConflictsWith (Cask::DSL)
Constants (Homebrew::Livecheck)
Constants (RuboCop::Cask)
Container (Cask::DSL)
Context
ContextStruct (Context)
Cop (RuboCop)
CoreTap
Cpan (Homebrew::Livecheck::Strategy)
Curl (Utils)
CurlApacheMirrorDownloadStrategy
CurlDownloadStrategy
CurlDownloadStrategyError
CurlGitHubPackagesDownloadStrategy
CurlPostDownloadStrategy
Cvs (UnpackStrategy)
CxxStdlib
CyclicDependencyError

DATAPatch
DSL (Cask)
DSL (Cask::URL)
DSL (BuildEnvironment)
Debrew
Denylist (Cask)
Dependable
Dependencies
DependenciesHelpers
Dependency
DependencyCollector
DependencyOrder (RuboCop::Cop::FormulaAudit)
DependentsMessage (Homebrew::Uninstall)
DependsOn (Cask::DSL)
DeprecateDisable
DeprecateDisableDate (RuboCop::Cop::FormulaAudit)
DeprecateDisableReason (RuboCop::Cop::FormulaAudit)
DeprecatedOption
Desc (RuboCop::Cop::FormulaAudit)
Desc (RuboCop::Cop::Cask)
DescHelper (RuboCop::Cop)
DescriptionCacheStore
Descriptions
DeveloperDependentsMessage (Homebrew::Uninstall)
Diagnostic (Homebrew)
Dictionary (Cask::Artifact)
Directory (UnpackStrategy)
DirectoryNotWritableError (Keg)
DiskUsageExtension
Dmg (UnpackStrategy)
Download (Homebrew::API)
Download (Cask)
DownloadError
DownloadStrategy (Homebrew::API)
DownloadStrategyDetector
Downloadable
DuplicateResourceError

ELFShim
ENV
ElectronBuilder (Homebrew::Livecheck::Strategy)
EmbeddedPatch
EmptyError (UnpackStrategy::Dmg::Bom)
Entry (Debrew::Menu)
EnvActivation
EnvConfig (Homebrew)
Error (MacOSVersion)
Error (Homebrew::Livecheck)
Error (Utils::Inreplace)
Error (GitHub::API)
Error (UnpackStrategy::Dmg::Bom)
ErrorDuringExecution
ExceptionMixin (Ignorable)
ExecShellMetacharacters (RuboCop::Cop::Homebrew)
Executable (UnpackStrategy)
ExternalPatch
ExtractPlist (Homebrew::Livecheck::Strategy)

Fetch (Homebrew)
Filename (Bottle)
Files (RuboCop::Cop::FormulaAudit)
Font (Cask::Artifact)
Formatter
Formula
Formula (Debrew)
Formula (Homebrew::API)
FormulaAPILoader (Formulary)
FormulaAST (Utils::AST)
FormulaAmbiguousPythonError
FormulaAudit (RuboCop::Cop)
FormulaAuditStrict (RuboCop::Cop)
FormulaAuditor (Homebrew)
FormulaCellarChecks
FormulaClassUnavailableError
FormulaClassUnavailableErrorModule
FormulaConflict
FormulaConflictError
FormulaContentsLoader (Formulary)
FormulaCop (RuboCop::Cop)
FormulaCreator (Homebrew)
FormulaInfo
FormulaInstallationAlreadyAttemptedError
FormulaInstaller
FormulaLoader (Formulary)
FormulaLock
FormulaOrCaskUnavailableError
FormulaOrCaskUnspecifiedError
FormulaPin
FormulaSpecificationError
FormulaTextAuditor (Homebrew)
FormulaUnavailableError
FormulaUnknownPythonError
FormulaUnreadableError
FormulaUnreadableErrorModule
FormulaUnspecifiedError
FormulaValidationError
FormulaVersions
Formulary
Fossil (UnpackStrategy)
FossilDownloadStrategy
FreePort (Homebrew)
FromAPILoader (Cask::CaskLoader)
FromContentLoader (Cask::CaskLoader)
FromDefaultTapPathLoader (Cask::CaskLoader)
FromInstanceLoader (Cask::CaskLoader)
FromPathLoader (Formulary)
FromPathLoader (Cask::CaskLoader)
FromTapLoader (Cask::CaskLoader)
FromTapPathLoader (Cask::CaskLoader)
FromURILoader (Cask::CaskLoader)
FromUrlLoader (Formulary)

GenerateCompletionsDSL (RuboCop::Cop::FormulaAudit)
GenericUnar (UnpackStrategy)
Git (UnpackStrategy)
Git (Homebrew::Livecheck::Strategy)
Git (Utils)
GitDownloadStrategy
GitHub
GitHubArtifactDownloadStrategy
GitHubGitDownloadStrategy
GitHubPackages
GitHubReleases
GitHubRunner
GitHubRunnerMatrix
GitRepository
GitUrls (RuboCop::Cop::FormulaAudit)
GitUrls (RuboCop::Cop::FormulaAuditStrict)
GithubLatest (Homebrew::Livecheck::Strategy)
GithubReleases (Homebrew::Livecheck::Strategy)
Glibc (OS::Linux)
Gnome (Homebrew::Livecheck::Strategy)
Gnu (Homebrew::Livecheck::Strategy)
Go (Resource)
Go (Language)
Gzip (UnpackStrategy)
Gzip (Utils)

HTTPNotFoundError (GitHub::API)
Hackage (Homebrew::Livecheck::Strategy)
Hardware
HeadSoftwareSpec
HeaderMatch (Homebrew::Livecheck::Strategy)
Help (Homebrew)
HelperFunctions (RuboCop::Cop)
Homebrew
Homebrew (RuboCop::Cop)
HomebrewCurlDownloadStrategy
HomebrewCurlDownloadStrategyError
Homepage (RuboCop::Cop::FormulaAudit)
HomepageUrlTrailingSlash (RuboCop::Cop::Cask)

ILoader (Cask::CaskLoader)
IO
IORead (RuboCop::Cop::Homebrew)
Ignorable
IgnoreDirectiveDocstringParser
Info (Cask)
InputMethod (Cask::Artifact)
Inreplace (Utils)
Install (Homebrew)
InstallRenamed
InstalledDependents
Installer (Cask)
Installer (Cask::Artifact)
InternetPlugin (Cask::Artifact)
InvalidConstraintError (Homebrew::CLI)
Item (Homebrew::Livecheck::Strategy::Sparkle)
Item (Homebrew::Livecheck::Strategy::ExtractPlist)

Jar (UnpackStrategy)
Java (Language)
Json (Homebrew::Livecheck::Strategy)

Keg
KegOnly (RuboCop::Cop::FormulaAudit)
KegOnlyReason
KegUnspecifiedError
Kernel
Kernel (OS::Linux)
KeyboardLayout (Cask::Artifact)

Language
Launchpad (Homebrew::Livecheck::Strategy)
LazyObject
Lha (UnpackStrategy)
LicenseArrays (RuboCop::Cop::FormulaAudit)
Licenses (RuboCop::Cop::FormulaAudit)
Lines (RuboCop::Cop::FormulaAudit)
Link (Utils)
LinkError (Keg)
LinkageCacheStore
LinkageChecker
Linux (OS)
LinuxRequirement
LinuxRunnerSpec
List (Cask)
Livecheck
Livecheck (Homebrew)
LivecheckRegexCaseInsensitive (RuboCop::Cop::FormulaAudit)
LivecheckRegexExtension (RuboCop::Cop::FormulaAudit)
LivecheckRegexIfPageMatch (RuboCop::Cop::FormulaAudit)
LivecheckRegexParentheses (RuboCop::Cop::FormulaAudit)
LivecheckSkip (RuboCop::Cop::FormulaAudit)
LivecheckUrlProvided (RuboCop::Cop::FormulaAudit)
LivecheckUrlSymbol (RuboCop::Cop::FormulaAudit)
LivecheckVersion (Homebrew::Livecheck)
LocalBottleDownloadStrategy
Locale
LockFile
LuaRock (UnpackStrategy)
Lzip (UnpackStrategy)
Lzma (UnpackStrategy)

Mac (OS)
MacOSAndLinux (OnSystem)
MacOSOnly (OnSystem)
MacOSOverride (Utils::Bottles)
MacOSRequirement
MacOSRunnerSpec
MacOSVersion
MacOSVersions
MachOShim
MakeCheck (RuboCop::Cop::FormulaAuditStrict)
Manpage (Cask::Artifact)
Manpages (Homebrew)
ManualInstaller (Cask::Artifact::Installer)
MaxNamedArgumentsError (Homebrew::CLI)
Mdimporter (Cask::Artifact)
Mechanize
Menu (Debrew)
Mercurial (UnpackStrategy)
MercurialDownloadStrategy
Messages
Metadata (Cask)
Metafiles
MethodDeprecatedError
MicrosoftOfficeXml (UnpackStrategy)
MigrationNeededError (Migrator)
Migrator
Migrator (Cask)
MigratorDifferentTapsError (Migrator)
MigratorNoOldpathError (Migrator)
MinNamedArgumentsError (Homebrew::CLI)
Miscellaneous (RuboCop::Cop::FormulaAudit)
MissingApplyError
MissingAuthenticationError (GitHub::API)
MissingFormula (Homebrew)
Mixin (SystemCommand)
Mktemp
Module
MoveToExtendOS (RuboCop::Cop::Homebrew)
Moved (Cask::Artifact)
MpiCheck (RuboCop::Cop::FormulaAudit)
MultipleCaskErrors (Cask)
MultipleVersionsInstalledError

NamedArgs (Homebrew::CLI)
NoOverrides (RuboCop::Cop::Cask)
NoSDKError (OS::Mac::BaseSDKLocator)
NoSuchKegError
NoUnzipCurlDownloadStrategy
Node (RuboCop::AST)
Node (Language)
NondeveloperDependentsMessage (Homebrew::Uninstall)
NotAKegError
Npm (Homebrew::Livecheck::Strategy)
NullLoader (Formulary)
NullLoader (Cask::CaskLoader)
NumberOfNamedArgumentsError (Homebrew::CLI)
NumericToken (Version)

OS
Object
Offense (Homebrew::Style)
Offenses (Homebrew::Style)
OnDescStanza (RuboCop::Cop::Cask)
OnHomepageStanza (RuboCop::Cop::Cask)
OnSystem
OnSystemConditionals (RuboCop::Cop::FormulaAudit)
OnSystemConditionals (RuboCop::Cop::Cask)
OnSystemConditionalsHelper (RuboCop::Cop)
OnUrlStanza (RuboCop::Cop::Cask)
OperationInProgressError
Option
OptionConflictError (Homebrew::CLI)
OptionConstraintError (Homebrew::CLI)
OptionDeclarations (RuboCop::Cop::FormulaAudit)
Options
Options (RuboCop::Cop::FormulaAudit)
Otf (UnpackStrategy)

P7Zip (UnpackStrategy)
PATH
Package (PyPI)
PageMatch (Homebrew::Livecheck::Strategy)
PageWithURL (Cask::URL::BlockDSL)
Parlour (Homebrew)
Parser (Homebrew::CLI)
Parser (Version)
ParserError (Locale)
Partial (Resource)
Patch
PatchResource (Resource)
PatchToken (Version)
Patches (RuboCop::Cop::FormulaAudit)
Pathname
Pax (UnpackStrategy)
Perl (Language)
Pkg (Cask)
Pkg (Cask::Artifact)
Pkg (UnpackStrategy)
PkgVersion
PostToken (Version)
Postflight (Cask::DSL)
PostflightBlock (Cask::Artifact)
PourBottleCheck
Pourable (AbstractDownloadStrategy)
PreToken (Version)
Predicable
Preflight (Cask::DSL)
PreflightBlock (Cask::Artifact)
Prefpane (Cask::Artifact)
PrettyListing
ProvidedByMacos (RuboCop::Cop::FormulaAudit)
PyPI
PyPiUrls (RuboCop::Cop::FormulaAudit)
PyoxidizerCheck (RuboCop::Cop::FormulaAudit)
Pypi (Homebrew::Livecheck::Strategy)
Python (Language)
PythonVersions (RuboCop::Cop::FormulaAudit)

Qlplugin (Cask::Artifact)
Quarantine (Cask)

RCToken (Version)
Rar (UnpackStrategy)
RateLimitExceededError (GitHub::API)
Readall
RegexParser (Version)
Reinstall (Cask)
Relocated (Cask::Artifact)
Relocation (Keg)
Repology
Reporter
ReporterHub
ReporterRevisionUnsetError (Reporter)
Requirement
Requirement (CaskDependent)
Requirements
Requirements (RuboCop::Cop::FormulaAuditStrict)
Resource
ResourceAuditor (Homebrew)
ResourceMissingError
ResourceStageContext
Result (SystemCommand)
RewriteInfo (Utils::Shebang)
RuboCop

SDK (OS::Mac)
SPDX
SafePopenCommands (RuboCop::Cop::FormulaAudit)
Sandbox
ScreenSaver (Cask::Artifact)
ScriptInstaller (Cask::Artifact::Installer)
Search (Homebrew)
SelfExtractingExecutable (UnpackStrategy)
Service (Homebrew)
Service (RuboCop::Cop::FormulaAudit)
Service (Cask::Artifact)
Service (Utils)
Settings (Homebrew)
SharedAudits
SharedEnvExtension
Shebang (Language::Perl)
Shebang (Utils)
Shebang (Language::Python)
ShebangDetectionError
Shell (Utils)
ShellCommands (RuboCop::Cop::Homebrew)
ShellVariables (RuboCop::Cop::FormulaAudit)
SimulateSystem (Homebrew)
SingleGenerateCompletionsDSLCall (RuboCop::Cop::FormulaAudit)
Sit (UnpackStrategy)
SkipConditions (Homebrew::Livecheck)
SoftwareSpec
SourceLocation (Homebrew)
Sourceforge (Homebrew::Livecheck::Strategy)
Sparkle (Homebrew::Livecheck::Strategy)
StageOnly (Cask::Artifact)
Staged (Cask)
Stanza (RuboCop::Cask::AST)
StanzaBlock (RuboCop::Cask::AST)
StanzaGrouping (RuboCop::Cop::Cask)
StanzaOrder (RuboCop::Cop::Cask)
Stdenv
StemParser (Version)
Strategy (Homebrew::Livecheck)
String
StringInreplaceExtension
StringPatch
StringToken (Version)
Style (Homebrew)
Subversion (UnpackStrategy)
SubversionDownloadStrategy
Suite (Cask::Artifact)
Superenv
Svn (Utils)
Symbol
Symlinked (Cask::Artifact)
SystemCommand
SystemConfig

Tab
Tag (Utils::Bottles)
TagSpecification (Utils::Bottles)
Tap
TapAlreadyTappedError
TapAuditor (Homebrew)
TapCaskAmbiguityError (Cask)
TapCaskUnavailableError (Cask)
TapConfig
TapCoreRemoteMismatchError
TapDependency
TapFormulaAmbiguityError
TapFormulaClassUnavailableError
TapFormulaOrCaskUnavailableError
TapFormulaUnavailableError
TapFormulaUnreadableError
TapFormulaWithOldnameAmbiguityError
TapLoader (Formulary)
TapNoCustomRemoteError
TapRemoteMismatchError
TapUnavailableError
Tar (UnpackStrategy)
Tar (Utils)
Test (RuboCop::Cop::FormulaAudit)
TestPresent (RuboCop::Cop::FormulaAuditStrict)
TestRunnerFormula
Text (RuboCop::Cop::FormulaAudit)
Text (RuboCop::Cop::FormulaAuditStrict)
Time
TimeRemaining
Token (Version)
TopologicalHash (Utils)
Ttf (UnpackStrategy)
Tty

URL
URL (Cask)
UnbottledError
Uncompressed (UnpackStrategy)
Uninstall (Cask)
Uninstall (Cask::Artifact)
Uninstall (Homebrew)
UninstallPostflight (Cask::DSL)
UninstallPreflight (Cask::DSL)
Unlink (Homebrew)
UnpackStrategy
UnsatisfiedRequirements
UnsupportedInstallationMethod
UnversionedCaskChecker (Homebrew)
Upgrade (Cask)
Upgrade (Homebrew)
Url (RuboCop::Cop::Cask)
UrlLegacyCommaSeparators (RuboCop::Cop::Cask)
UrlParser (Version)
Urls (RuboCop::Cop::FormulaAudit)
UsageError
User
UsesFromMacos (RuboCop::Cop::FormulaAudit)
Utils
Utils (Cask)

VCSDownloadStrategy
ValidationFailedError (GitHub::API)
Variables (Homebrew::Manpages)
Variables (Homebrew::Completions)
Variables (RuboCop::Cop::Cask)
Version
Version (Cask::DSL)
Version (RuboCop::Cop::FormulaAudit)
Virtualenv (Language::Python::Virtualenv)
Virtualenv (Language::Python)
Volumes (Homebrew::Diagnostic)
Vst3Plugin (Cask::Artifact)
VstPlugin (Cask::Artifact)

Warnings

Xar (UnpackStrategy)
Xcode (OS::Mac)
XcodeRequirement
XcodeSDKLocator (OS::Mac)
Xml (Homebrew::Livecheck::Strategy)
Xorg (Homebrew::Livecheck::Strategy)
Xz (UnpackStrategy)

Yaml (Homebrew::Livecheck::Strategy)

Zap (Cask::Artifact)
Zip (UnpackStrategy)
Zstd (UnpackStrategy)