Skip to content

๐Ÿ› ๏ธ Composer CLI Methods Reference โ€‹

This section lists all method reference pages for this module, one page per method, covering signature, parameters, return values, examples, and advanced notes.

MethodDocumentation
๐Ÿ—๏ธ AddAutoloadadd-autoload
๐Ÿชช AddBearerTokenadd-bearer-token
๐ŸŒ AddComposerRepositoryadd-composer-repository
๐Ÿ”‘ AddGitHubTokenadd-github-token
๐Ÿ”‘ AddGitLabTokenadd-gitlab-token
๐Ÿ” AddHTTPBasicAuthadd-http-basic-auth
๐Ÿ“ฅ AddPackagistRepositoryadd-packagist-repository
๐Ÿ“ AddPathRepositoryadd-path-repository
โž• AddRequireadd-require
๐Ÿงฉ AddScriptadd-script
๐Ÿ”ง AddVcsRepositoryadd-vcs-repository
๐Ÿ—œ๏ธ Archivearchive
๐Ÿ“ฆ ArchivePackagearchive-package
๐Ÿ—œ๏ธ ArchiveProjectarchive-project
๐Ÿ“ฆ AuditLockaudit-lock
๐Ÿ”’ Auditaudit
๐Ÿ“Š AuditWithFormataudit-with-format
๐Ÿงฉ AuditWithJSONaudit-with-json
๐Ÿ” AuditWithoutDevaudit-without-dev
๐Ÿ—‘๏ธ BatchRemovebatch-remove
๐Ÿ“ฆ BatchRequirebatch-require
๐ŸŒ BrowsePackagebrowse-package
๐Ÿ—๏ธ BuildSatisbuild-satis
๐Ÿ“ˆ BumpPackagesbump-packages
๐Ÿ“ˆ CheckForOutdatedPackagescheck-for-outdated-packages
๐Ÿ›ก๏ธ CheckForSecurityVulnerabilitiescheck-for-security-vulnerabilities
๐Ÿ”“ CheckLicenses Check dependency license compatibilitycheck-licenses
โœ… Checkcheck
๐Ÿ–ฅ๏ธ CheckPlatformcheck-platform
๐Ÿ–ฅ๏ธ CheckPlatformReqs Check platform requirementscheck-platform-reqs
๐Ÿ“‹ CheckPlatformReqsStructuredcheck-platform-reqs-structured
๐Ÿ”’ CheckPlatformWithLockcheck-platform-with-lock
๐ŸŽฏ CheckStructuredcheck-structured
๐Ÿงน ClearCacheclear-cache
๐Ÿš€ CreateProjectcreate-project
๐Ÿ“ฆ CreateSatisConfigcreate-satis-config
โš™๏ธ DefaultOptionsdefault-options
๐Ÿฉบ Diagnosediagnose
๐Ÿ”ฌ DiagnoseStructureddiagnose-structured
๐Ÿคซ DisableInteractiondisable-interaction
๐Ÿงฉ DumpAutoloaddump-autoload
๐Ÿ› ๏ธ DumpAutoloadWithOptionsdump-autoload-with-options
๐Ÿ‘ค EnableSuperuserenable-superuser
๐Ÿ”ง EnsureInstalledensure-installed
๐ŸŒŸ ExecAllexec-all
โš™๏ธ Execexec
๐Ÿ˜ ExecPHPexec-php
๐ŸŽฏ ExecuteScriptexecute-script
๐Ÿ“‹ ExecWithListexec-with-list
๐Ÿ“ฆ ExtractPackageNamesFromOutputextract-package-names-from-output
๐ŸŽฏ ExtractVersionFromOutputextract-version-from-output
๐Ÿงฎ FormatVersionConstraintformat-version-constraint
๐Ÿ’ฐ Fundfund
๐Ÿ“Š FundWithJSONfund-with-json
โš ๏ธ GetAbandonedPackagesFromLockget-abandoned-packages-from-lock
๐Ÿšซ GetAbandonedPackagesget-abandoned-packages
๐Ÿ“ˆ GetAuditInfoget-audit-info
๐Ÿ“– GetAuthConfigget-auth-config
๐Ÿ’พ GetCacheDirget-cache-dir
๐Ÿ  GetComposerHomeget-composer-home
๐Ÿ“Š GetConfigStructuredget-config-structured
๐Ÿ”ง GetConfigWithGlobalget-config-with-global
๐ŸŽฏ GetDirectDependencyNamesget-direct-dependency-names
๐Ÿงญ GetEnvironmentInfoget-environment-info
๐Ÿ” GetEnvVariableget-env-variable
๐Ÿงฉ GetExtensionsget-extensions
๐Ÿ”— GetFundingURLsget-funding-urls
๐Ÿšจ GetHighSeverityVulnerabilitiesget-high-severity-vulnerabilities
๐Ÿ“‹ GetInstalledPackageNamesget-installed-package-names
๐Ÿงพ GetLicensesInfoget-licenses-info
๐Ÿ—บ๏ธ GetNamespaceMapget-namespace-map
โฌ†๏ธ GetOutdatedInfoget-outdated-info
๐Ÿ˜ GetPHPVersionget-php-version
๐Ÿ“Š GetProjectDependenciesget-project-dependencies
๐Ÿ“ฆ GetProjectInfoget-project-info
๐Ÿ—๏ธ GetProjectSummaryget-project-summary
๐Ÿ” GetRequireWithVersionget-require-with-version
โŒจ๏ธ GetScriptsget-scripts
๐Ÿ“ GetVendorDirget-vendor-dir
๐Ÿ“Š GetVersionInfoget-version-info
๐Ÿ”ข GetVersionget-version
๐Ÿ“ฆ GlobalInstallglobal-install
๐Ÿ“‹ GlobalListglobal-list
๐Ÿ—‘๏ธ GlobalRemoveglobal-remove
๐ŸŒ GlobalRequireglobal-require
๐Ÿ”„ GlobalUpdateglobal-update
๐Ÿ”’ HasComposerLockhas-composer-lock
๐Ÿ” HasExtensionhas-extension
โœ… HasFundinghas-funding
๐Ÿ“ HasVendorDirhas-vendor-dir
โš ๏ธ HasVulnerabilitieshas-vulnerabilities
๐Ÿฅ HealthCheckhealth-check
๐Ÿ—๏ธ InitProjectinit-project
๐Ÿš€ InitSatisinit-satis
๐Ÿ” InstallDryRuninstall-dry-run
๐Ÿ“ฆ Installinstall
๐Ÿšซ InstallNoScriptsinstall-no-scripts
โšก InstallWithAPCu Install dependencies with APCu autoload cache enabledinstall-with-apcu
๐Ÿ› ๏ธ InstallWithOptionsinstall-with-options
๐Ÿ“ฅ InstallWithPreferDistinstall-with-prefer-dist
๐Ÿ“ฅ InstallWithPreferSourceinstall-with-prefer-source
โœ… IsInstalledis-installed
๐Ÿงฉ IsPackageDevis-package-dev
โœ… IsPackageInstalledis-package-installed
โœ… IsPlatformAvailableis-platform-available
๐Ÿ“ฆ IsProjectis-project
๐Ÿ“œ Licenseslicenses
๐Ÿ“œ LicensesWithFormatlicenses-with-format
๐Ÿ“‹ ListConfiglist-config
๐Ÿ” ListRepositorieslist-repositories
๐Ÿ“š ListScriptslist-scripts
โš™๏ธ LocalExeclocal-exec
๐Ÿ”’ LockPackageVersionlock-package-version
๐Ÿš€ Newnew
๐Ÿ“ NormalizeComposerJsonnormalize-composer-json
๐Ÿ“ฆ OutdatedPackagesDirect Show only outdated packages in direct dependenciesoutdated-packages-direct
โฌ†๏ธ OutdatedPackagesoutdated-packages
โœ… ParseCheckOutputparse-check-output
๐Ÿ”’ ParseComposerAuditJSONparse-composer-audit-json
๐Ÿ“ˆ ParseComposerOutdatedJSONparse-composer-outdated-json
๐Ÿ” ParseComposerShowJSONparse-composer-show-json
๐ŸŒณ ParseDependencyTreeJSONparse-dependency-tree-json
๐Ÿฉบ ParseDiagnoseOutputparse-diagnose-output
๐Ÿ“ฆ ParseInstallOutputparse-install-output
๐Ÿ“‹ ParseStatusOutputparse-status-output
๐Ÿ”„ ParseUpdateOutputparse-update-output
๐Ÿท๏ธ ParseVersionOutputparse-version-output
๐Ÿšซ Prohibitprohibit
๐Ÿš€ QuickSetupquick-setup
๐Ÿ“„ ReadComposerJSONread-composer-json
โ™ป๏ธ Reinstallreinstall
๐Ÿงช RemoveDryRun Simulate removing a packageremove-dry-run
โž– Removeremove
โž– RemoveMultipleremove-multiple
๐Ÿ—‘๏ธ RemoveRepositoryremove-repository
๐Ÿ—‘๏ธ RemoveRequireremove-require
๐Ÿงน RemoveScriptremove-script
๐Ÿงน RemoveTokenremove-token
๐Ÿงช RequireDryRun Simulate adding a package dependencyrequire-dry-run
โž• RequireMultiplerequire-multiple
โž• RequirePackagerequire-package
๐Ÿ“ฆ RequirePackageWithOptions Add a package dependency with custom optionsrequire-package-with-options
๐Ÿ› ๏ธ Runrun
โšก RunScriptrun-script
๐ŸŒ RunWithContextrun-with-context
โฑ๏ธ RunWithTimeoutrun-with-timeout
๐Ÿ’พ SaveAuthConfigsave-auth-config
๐Ÿ”Ž SearchInfosearch-info
๐Ÿ”Ž Searchsearch
๐Ÿ”Ž SearchOnlyNamesearch-only-name
๐Ÿท๏ธ SearchWithTypesearch-with-type
๐Ÿš€ SelfUpdateself-update
โš™๏ธ SetConfigWithGlobalset-config-with-global
๐ŸŒ SetEnvVariableset-env-variable
๐Ÿ’พ SetMemoryLimitset-memory-limit
๐Ÿ“Š SetMinimumStabilityset-minimum-stability
๐ŸŽฏ SetPreferredInstallset-preferred-install
โœ… SetPreferStableset-prefer-stable
โฑ๏ธ SetProcessTimeoutset-process-timeout
๐Ÿ”ง SetPropertyset-property
๐Ÿ”ง SetWorkingDirset-working-dir
๐Ÿ“ฆ ShowAllPackagesshow-all-packages
๐ŸŒณ ShowDependencyTreeshow-dependency-tree
โœจ ShowPackageInfoshow-package-info
๐Ÿ”Ž ShowPackageshow-package
๐Ÿ”— ShowReverseDependenciesshow-reverse-dependencies
๐Ÿ“Š Statusstatus
๐Ÿ“ˆ StatusStructuredstatus-structured
๐Ÿ’ก Suggestssuggests
๐Ÿ” UpdateDryRunupdate-dry-run
โšก Updateupdate
๐Ÿ”„ UpdatePackageVersionupdate-package-version
๐Ÿ”— UpdateWithDependenciesupdate-with-dependencies
๐Ÿ”’ UpdateWithLockupdate-with-lock
๐Ÿ› ๏ธ UpdateWithOptionsupdate-with-options
๐Ÿงช ValidateComposerJsonvalidate-composer-json
๐Ÿ”’ ValidateComposerLockvalidate-composer-lock
โœ… Validatevalidate
๐Ÿ” ValidateSchemavalidate-schema
โœ… ValidateStrictvalidate-strict
๐Ÿงช ValidateStructuredvalidate-structured
๐Ÿšซ WhyNotPackagewhy-not-package
โ“ WhyPackagewhy-package
โœ๏ธ WriteComposerJSONwrite-composer-json

Released under the MIT License