🔍 ListRepositories

Lists all repositories configured in the current project's composer.json, equivalent to running composer config repositories.

When to use

Use this when you need to see which package sources (Packagist, private, VCS, path, etc.) the project currently has configured. Commonly used to troubleshoot dependency source issues or confirm that repository configuration has taken effect.

Signature

func (c *Composer) ListRepositories() (string, error)

Parameters

This method takes no parameters.

Return value

Return value	Type	Description
First return value	string	The list output of all configured repositories
Second return value	error	Returned when an error occurs while listing repositories; nil indicates success

Example

package main

import (
	"fmt"
	"log"

	"github.com/scagogogo/composer-skills/pkg/composer"
)

func main() {
	comp, err := composer.New(composer.DefaultOptions())
	if err != nil {
		log.Fatalf("Initialization failed: %v", err)
	}

	output, err := comp.ListRepositories()
	if err != nil {
		log.Fatalf("Failed to list repositories: %v", err)
	}

	fmt.Println("Configured repositories:")
	fmt.Println(output)
}

Advanced

• To list global repositories (effective for all projects), use ListGlobalRepositories().
• Methods for adding repositories: AddVcsRepository, AddComposerRepository, AddPathRepository, AddPackagistRepository.
• To remove a repository, use RemoveRepository.
• Under the hood it runs composer config repositories; the return is Composer's standard text output.