Merge pull request #4207 from AkihiroSuda/rename

Add `limactl rename OLD NEW`

Author: AkihiroSuda

cmd/limactl/clone.go

@@ -30,15 +30,30 @@ func newCloneCommand() *cobra.Command {
 Not to be confused with 'limactl copy' ('limactl cp').
 `,
 		Args:              WrapArgsError(cobra.ExactArgs(2)),
-		RunE:              cloneAction,
+		RunE:              cloneOrRenameAction,
 		ValidArgsFunction: cloneBashComplete,
 		GroupID:           advancedCommand,
 	}
 	editflags.RegisterEdit(cloneCommand, "[limactl edit] ")
 	return cloneCommand
 }
 
-func cloneAction(cmd *cobra.Command, args []string) error {
+func newRenameCommand() *cobra.Command {
+	renameCommand := &cobra.Command{
+		Use: "rename OLDINST NEWINST",
+		// No "mv" alias, to avoid confusion with a theoretical equivalent of `limactl cp` but s/cp/mv/.
+		Short:             "Rename an instance of Lima",
+		Args:              WrapArgsError(cobra.ExactArgs(2)),
+		RunE:              cloneOrRenameAction,
+		ValidArgsFunction: cloneBashComplete,
+		GroupID:           advancedCommand,
+	}
+	editflags.RegisterEdit(renameCommand, "[limactl edit] ")
+	return renameCommand
+}
+
+func cloneOrRenameAction(cmd *cobra.Command, args []string) error {
+	rename := cmd.Name() == "rename"
 	ctx := cmd.Context()
 	flags := cmd.Flags()
 	tty, err := flags.GetBool("tty")
@@ -55,7 +70,7 @@ func cloneAction(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	newInst, err := instance.Clone(ctx, oldInst, newInstName)
+	newInst, err := instance.CloneOrRename(ctx, oldInst, newInstName, rename)
 	if err != nil {
 		return err
 	}

cmd/limactl/main.go

@@ -202,6 +202,7 @@ func newApp() *cobra.Command {
 		newStartAtLoginCommand(),
 		newNetworkCommand(),
 		newCloneCommand(),
+		newRenameCommand(),
 	)
 	addPluginCommands(rootCmd)
 

pkg/instance/clone.go

@@ -22,15 +22,19 @@ import (
 	"github.com/lima-vm/lima/v2/pkg/store"
 )
 
-func Clone(ctx context.Context, oldInst *limatype.Instance, newInstName string) (*limatype.Instance, error) {
+func CloneOrRename(ctx context.Context, oldInst *limatype.Instance, newInstName string, rename bool) (*limatype.Instance, error) {
+	verb := "clone"
+	if rename {
+		verb = "rename"
+	}
 	if newInstName == "" {
 		return nil, errors.New("got empty instName")
 	}
 	if oldInst.Name == newInstName {
 		return nil, fmt.Errorf("new instance name %q must be different from %q", newInstName, oldInst.Name)
 	}
 	if oldInst.Status == limatype.StatusRunning {
-		return nil, errors.New("cannot clone a running instance")
+		return nil, errors.New("cannot " + verb + " a running instance")
 	}
 
 	newInstDir, err := dirnames.InstanceDir(newInstName)
@@ -80,13 +84,20 @@ func Clone(ctx context.Context, oldInst *limatype.Instance, newInstName string)
 		if slices.Contains(filenames.NullifyOnClone, base) {
 			return os.WriteFile(dst, nil, 0o666)
 		}
+		if rename {
+			return os.Rename(path, dst)
+		}
 		// CopyFile attempts copy-on-write when supported by the filesystem
 		return continuityfs.CopyFile(dst, path)
 	}
 
 	if err = filepath.WalkDir(oldInst.Dir, walkDirFn); err != nil {
 		return nil, err
 	}
-
+	if rename {
+		if err = os.RemoveAll(oldInst.Dir); err != nil {
+			return nil, err
+		}
+	}
 	return store.Inspect(ctx, newInstName)
 }