Skip to content

🔢 GetVersion

Gets the version number string of the current Composer executable. Equivalent to running composer --version and parsing the version number (e.g. 2.1.6) from the output.

When to use

Use this when you need to display the Composer version, perform version compatibility checks, or record the runtime environment in automation scripts. If you also need structured fields such as major/minor/patch numbers and the release date, use GetVersionInfo instead.

Signature

go
func (c *Composer) GetVersion() (string, error)

Parameters

This method takes no parameters.

Return value

Return valueTypeDescription
First return valuestringThe Composer version number, e.g. 2.1.6
Second return valueerrorReturned when executing the command or parsing the output fails

Example

go
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)
	}

	version, err := comp.GetVersion()
	if err != nil {
		log.Fatalf("Failed to get Composer version: %v", err)
	}
	fmt.Printf("Current Composer version: %s\n", version)
}

Advanced

  • To get structured version information (including major/minor/patch numbers and release date), use GetVersionInfo.
  • To upgrade Composer itself, use SelfUpdate.
  • Under the hood this runs Run("--version"); for custom commands, use Run.

Released under the MIT License