Add profile lib add command

It adds one or multiple libraries to the specified profile.

Author: MatteoPologruto

commands/cmderrors/cmderrors.go

@@ -435,7 +435,7 @@ func (e *PlatformLoadingError) Unwrap() error {
 	return e.Cause
 }
 
-// LibraryNotFoundError is returned when a platform is not found
+// LibraryNotFoundError is returned when a library is not found
 type LibraryNotFoundError struct {
 	Library string
 	Cause   error
@@ -883,3 +883,15 @@ func (e *InstanceNeedsReinitialization) GRPCStatus() *status.Status {
 		WithDetails(&rpc.InstanceNeedsReinitializationError{})
 	return st
 }
+
+// MissingProfileError is returned when the Profile is mandatory and not specified
+type MissingProfileError struct{}
+
+func (e *MissingProfileError) Error() string {
+	return i18n.Tr("Missing Profile name")
+}
+
+// GRPCStatus converts the error into a *status.Status
+func (e *MissingProfileError) GRPCStatus() *status.Status {
+	return status.New(codes.InvalidArgument, e.Error())
+}

commands/service_profile_lib_add.go

@@ -0,0 +1,80 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2025 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package commands
+
+import (
+	"context"
+
+	"github.com/arduino/arduino-cli/commands/cmderrors"
+	"github.com/arduino/arduino-cli/commands/internal/instances"
+	"github.com/arduino/arduino-cli/internal/arduino/sketch"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	paths "github.com/arduino/go-paths-helper"
+)
+
+func (s *arduinoCoreServerImpl) ProfileLibAdd(ctx context.Context, req *rpc.ProfileLibAddRequest) (*rpc.ProfileLibAddResponse, error) {
+	sketchPath := paths.New(req.GetSketchPath())
+	projectFilePath, err := sketchPath.Join("sketch.yaml").Abs()
+	if err != nil {
+		return nil, err
+	}
+
+	if req.GetProfileName() == "" {
+		return nil, &cmderrors.MissingProfileError{}
+	}
+
+	// Returns an error if the main file is missing from the sketch so there is no need to check if the path exists
+	sk, err := sketch.New(sketchPath)
+	if err != nil {
+		return nil, err
+	}
+
+	profile, err := sk.GetProfile(req.ProfileName)
+	if err != nil {
+		return nil, err
+	}
+
+	// Obtain the library index from the manager
+	li, err := instances.GetLibrariesIndex(req.GetInstance())
+	if err != nil {
+		return nil, err
+	}
+	version, err := parseVersion(req.LibVersion)
+	if err != nil {
+		return nil, err
+	}
+	libRelease, err := li.FindRelease(req.GetLibName(), version)
+	if err != nil {
+		return nil, err
+	}
+
+	// If the library has been already added to the profile, just update the version
+	if lib, _ := profile.GetLibrary(req.LibName); lib != nil {
+		lib.Version = libRelease.GetVersion()
+	} else {
+		profile.Libraries = append(profile.Libraries, &sketch.ProfileLibraryReference{
+			Library: req.GetLibName(),
+			Version: libRelease.GetVersion(),
+		})
+	}
+
+	err = projectFilePath.WriteFile([]byte(sk.Project.AsYaml()))
+	if err != nil {
+		return nil, err
+	}
+
+	return &rpc.ProfileLibAddResponse{LibName: req.LibName, LibVersion: libRelease.GetVersion().String()}, nil
+}

internal/arduino/sketch/profiles.go

@@ -24,6 +24,7 @@ import (
 	"regexp"
 	"strings"
 
+	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/internal/arduino/utils"
 	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -119,6 +120,16 @@ type Profile struct {
 	Libraries  ProfileRequiredLibraries `yaml:"libraries"`
 }
 
+// GetLibrary returns the requested library or an error if not found
+func (p *Profile) GetLibrary(libraryName string) (*ProfileLibraryReference, error) {
+	for _, l := range p.Libraries {
+		if l.Library == libraryName {
+			return l, nil
+		}
+	}
+	return nil, &cmderrors.LibraryNotFoundError{Library: libraryName}
+}
+
 // ToRpc converts this Profile to an rpc.SketchProfile
 func (p *Profile) ToRpc() *rpc.SketchProfile {
 	var portConfig *rpc.MonitorPortConfiguration

internal/cli/profile/lib.go

@@ -0,0 +1,107 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2025 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package profile
+
+import (
+	"context"
+	"fmt"
+	"os"
+
+	"github.com/arduino/arduino-cli/internal/cli/arguments"
+	"github.com/arduino/arduino-cli/internal/cli/feedback"
+	"github.com/arduino/arduino-cli/internal/cli/instance"
+	"github.com/arduino/arduino-cli/internal/cli/lib"
+	"github.com/arduino/arduino-cli/internal/i18n"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/spf13/cobra"
+)
+
+func initLibCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
+	libCommand := &cobra.Command{
+		Use:   "lib",
+		Short: i18n.Tr("Profile commands about libraries."),
+		Long:  i18n.Tr("Profile commands about libraries."),
+		Example: "" +
+			"  " + os.Args[0] + " profile lib add AudioZero -m my_profile\n" +
+			"  " + os.Args[0] + " profile lib remove Arduino_JSON --profile my_profile\n",
+	}
+
+	libCommand.AddCommand(initLibAddCommand(srv))
+
+	return libCommand
+}
+
+func initLibAddCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
+	var destDir string
+
+	addCommand := &cobra.Command{
+		Use:   fmt.Sprintf("add %s[@%s]...", i18n.Tr("LIBRARY"), i18n.Tr("VERSION_NUMBER")),
+		Short: i18n.Tr("Adds a library to the profile."),
+		Long:  i18n.Tr("Adds a library to the profile."),
+		Example: "" +
+			"  " + os.Args[0] + " profile lib add AudioZero -m my_profile\n" +
+			"  " + os.Args[0] + " profile lib add Arduino_JSON@0.2.0 --profile my_profile\n",
+		Args: cobra.MinimumNArgs(1),
+		Run: func(cmd *cobra.Command, args []string) {
+			runLibAddCommand(cmd.Context(), args, srv, destDir)
+		},
+		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+			return arguments.GetInstallableLibs(cmd.Context(), srv), cobra.ShellCompDirectiveDefault
+		},
+	}
+
+	addCommand.Flags().StringVar(&destDir, "dest-dir", "", i18n.Tr("Location of the project file."))
+	profileArg.AddToCommand(addCommand, srv)
+
+	return addCommand
+}
+
+func runLibAddCommand(ctx context.Context, args []string, srv rpc.ArduinoCoreServiceServer, destDir string) {
+	sketchPath := arguments.InitSketchPath(destDir)
+
+	instance := instance.CreateAndInit(ctx, srv)
+	libRefs, err := lib.ParseLibraryReferenceArgsAndAdjustCase(ctx, srv, instance, args)
+	if err != nil {
+		feedback.Fatal(i18n.Tr("Arguments error: %v", err), feedback.ErrBadArgument)
+	}
+	for _, lib := range libRefs {
+		resp, err := srv.ProfileLibAdd(ctx, &rpc.ProfileLibAddRequest{
+			Instance:    instance,
+			SketchPath:  sketchPath.String(),
+			ProfileName: profileArg.Get(),
+			LibName:     lib.Name,
+			LibVersion:  lib.Version,
+		})
+		if err != nil {
+			feedback.Fatal(i18n.Tr("Error adding %s to the profile %s: %v", lib.Name, profileArg.Get(), err), feedback.ErrGeneric)
+		}
+		feedback.PrintResult(libResult{LibName: resp.GetLibName(), LibVersion: resp.GetLibVersion(), ProfileName: profileArg.Get()})
+	}
+}
+
+type libResult struct {
+	LibName     string `json:"library_name"`
+	LibVersion  string `json:"library_version"`
+	ProfileName string `json:"profile_name"`
+}
+
+func (lr libResult) Data() interface{} {
+	return lr
+}
+
+func (lr libResult) String() string {
+	return i18n.Tr("Profile %s: %s@%s added succesfully", lr.ProfileName, lr.LibName, lr.LibVersion)
+}

internal/cli/profile/profile.go

@@ -38,6 +38,7 @@ func NewCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 	}
 
 	profileCommand.AddCommand(initInitCommand(srv))
+	profileCommand.AddCommand(initLibCommand(srv))
 
 	return profileCommand
 }