pixi: updated with scraped structure

Author: rsteube

completers/common/pixi_completer/cmd/add.go

@@ -7,45 +7,41 @@ import (
 )
 
 var addCmd = &cobra.Command{
-	Use:   "add",
-	Short: "Adds dependencies to the workspace",
-	Run:   func(cmd *cobra.Command, args []string) {},
+	Use:     "add",
+	Short:   "Adds dependencies to the workspace",
+	Aliases: []string{"a"},
+	Run:     func(cmd *cobra.Command, args []string) {},
 }
 
 func init() {
 	carapace.Gen(addCmd).Standalone()
 
 	addCmd.Flags().String("auth-file", "", "Path to the file containing the authentication token")
 	addCmd.Flags().String("branch", "", "The git branch")
-	addCmd.Flags().Bool("build", false, "The specified dependencies are build dependencies")
-	addCmd.Flags().String("concurrent-downloads", "", "Max concurrent network requests")
-	addCmd.Flags().String("concurrent-solves", "", "Max concurrent solves")
+	addCmd.Flags().String("concurrent-downloads", "", "Max concurrent network requests, default is `50`")
+	addCmd.Flags().String("concurrent-solves", "", "Max concurrent solves, default is the number of CPUs")
 	addCmd.Flags().Bool("editable", false, "Whether the pypi requirement should be editable")
 	addCmd.Flags().StringP("feature", "f", "", "The feature for which the dependency should be modified")
-	addCmd.Flags().Bool("frozen", false, "Install the environment as defined in the lockfile")
+	addCmd.Flags().Bool("frozen", false, "Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file")
 	addCmd.Flags().StringP("git", "g", "", "The git url to use when adding a git dependency")
-	addCmd.Flags().Bool("host", false, "The specified dependencies are host dependencies")
-	addCmd.Flags().Bool("locked", false, "Check if lockfile is up-to-date before installing the environment")
-	addCmd.Flags().StringP("manifest-path", "m", "", "The path to pixi.toml, pyproject.toml, or the workspace directory")
+	addCmd.Flags().Bool("locked", false, "Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file")
 	addCmd.Flags().Bool("no-install", false, "Don't modify the environment, only modify the lock-file")
-	addCmd.Flags().Bool("no-lockfile-update", false, "Skips lock-file updates")
 	addCmd.Flags().String("pinning-strategy", "", "Set pinning strategy")
-	addCmd.Flags().StringP("platform", "p", "", "The platform for which the dependency should be modified")
-	addCmd.Flags().Bool("pypi", false, "The specified dependencies are pypi dependencies")
-	addCmd.Flags().String("pypi-keyring-provider", "", "Specifies whether to use the keyring for PyPI")
+	addCmd.Flags().StringSliceP("platform", "p", nil, "The platform for which the dependency should be modified")
+	addCmd.Flags().Bool("pypi", false, "The specified dependencies are pypi dependencies. Conflicts with `host` and `build`")
+	addCmd.Flags().String("pypi-keyring-provider", "", "Specifies whether to use the keyring to look up credentials for PyPI")
 	addCmd.Flags().String("rev", "", "The git revision")
-	addCmd.Flags().Bool("run-post-link-scripts", false, "Run post-link scripts")
+	addCmd.Flags().Bool("run-post-link-scripts", false, "Run post-link scripts (insecure)")
 	addCmd.Flags().StringP("subdir", "s", "", "The subdirectory of the git repository to use")
 	addCmd.Flags().String("tag", "", "The git tag")
 	addCmd.Flags().Bool("tls-no-verify", false, "Do not verify the TLS certificate of the server")
-	addCmd.Flags().String("tls-root-certs", "", "Which TLS root certificates to use")
-	addCmd.Flags().Bool("use-environment-activation-cache", false, "Use environment activation cache")
+	addCmd.Flags().String("tls-root-certs", "", "Which TLS root certificates to use: 'webpki' (bundled Mozilla roots), 'native' (system store), or 'all' (both)")
+	addCmd.Flags().Bool("use-environment-activation-cache", false, "Use environment activation cache (experimental)")
 	rootCmd.AddCommand(addCmd)
 
 	carapace.Gen(addCmd).FlagCompletion(carapace.ActionMap{
 		"auth-file":             carapace.ActionFiles(),
 		"feature":               pixi.ActionFeatures(),
-		"manifest-path":         carapace.ActionFiles(),
 		"pinning-strategy":      carapace.ActionValues("semver", "minor", "major", "latest-up", "exact-version", "no-pin"),
 		"platform":              pixi.ActionPlatforms(),
 		"pypi-keyring-provider": carapace.ActionValues("disabled", "subprocess"),

completers/common/pixi_completer/cmd/auth_help.go

@@ -0,0 +1,18 @@
+package cmd
+
+import (
+	"github.com/carapace-sh/carapace"
+	"github.com/spf13/cobra"
+)
+
+var auth_helpCmd = &cobra.Command{
+	Use:   "help",
+	Short: "Print this message or the help of the given subcommand(s)",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(auth_helpCmd).Standalone()
+
+	authCmd.AddCommand(auth_helpCmd)
+}

completers/common/pixi_completer/cmd/auth_help_help.go

@@ -0,0 +1,18 @@
+package cmd
+
+import (
+	"github.com/carapace-sh/carapace"
+	"github.com/spf13/cobra"
+)
+
+var auth_help_helpCmd = &cobra.Command{
+	Use:   "help",
+	Short: "Print this message or the help of the given subcommand(s)",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(auth_help_helpCmd).Standalone()
+
+	auth_helpCmd.AddCommand(auth_help_helpCmd)
+}

completers/common/pixi_completer/cmd/auth_help_login.go

@@ -0,0 +1,18 @@
+package cmd
+
+import (
+	"github.com/carapace-sh/carapace"
+	"github.com/spf13/cobra"
+)
+
+var auth_help_loginCmd = &cobra.Command{
+	Use:   "login",
+	Short: "Store authentication information for a given host",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(auth_help_loginCmd).Standalone()
+
+	auth_helpCmd.AddCommand(auth_help_loginCmd)
+}

completers/common/pixi_completer/cmd/auth_help_logout.go

@@ -0,0 +1,18 @@
+package cmd
+
+import (
+	"github.com/carapace-sh/carapace"
+	"github.com/spf13/cobra"
+)
+
+var auth_help_logoutCmd = &cobra.Command{
+	Use:   "logout",
+	Short: "Remove authentication information for a given host",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(auth_help_logoutCmd).Standalone()
+
+	auth_helpCmd.AddCommand(auth_help_logoutCmd)
+}

completers/common/pixi_completer/cmd/auth_login.go

@@ -15,11 +15,11 @@ func init() {
 	carapace.Gen(auth_loginCmd).Standalone()
 
 	auth_loginCmd.Flags().String("conda-token", "", "The token to use on anaconda.org / quetz authentication")
-	auth_loginCmd.Flags().String("password", "", "The password to use for basic HTTP authentication")
+	auth_loginCmd.Flags().String("password", "", "The password to use (for basic HTTP authentication)")
 	auth_loginCmd.Flags().String("s3-access-key-id", "", "The S3 access key ID")
 	auth_loginCmd.Flags().String("s3-secret-access-key", "", "The S3 secret access key")
 	auth_loginCmd.Flags().String("s3-session-token", "", "The S3 session token")
-	auth_loginCmd.Flags().String("token", "", "The token to use for authentication with prefix.dev")
-	auth_loginCmd.Flags().String("username", "", "The username to use for basic HTTP authentication")
+	auth_loginCmd.Flags().String("token", "", "The token to use (for authentication with prefix.dev)")
+	auth_loginCmd.Flags().String("username", "", "The username to use (for basic HTTP authentication)")
 	authCmd.AddCommand(auth_loginCmd)
 }

completers/common/pixi_completer/cmd/build.go

@@ -7,33 +7,32 @@ import (
 
 var buildCmd = &cobra.Command{
 	Use:   "build",
-	Short: "Build a conda package from a Pixi package",
+	Short: "Build a conda package from a Pixi package.",
 	Run:   func(cmd *cobra.Command, args []string) {},
 }
 
 func init() {
 	carapace.Gen(buildCmd).Standalone()
 
-	buildCmd.Flags().Bool("as-is", false, "Shorthand for --no-install and --frozen")
+	buildCmd.Flags().Bool("as-is", false, "Shorthand for the combination of --no-install and --frozen")
 	buildCmd.Flags().String("auth-file", "", "Path to the file containing the authentication token")
 	buildCmd.Flags().StringP("build-dir", "b", "", "The directory to use for incremental builds artifacts")
-	buildCmd.Flags().String("build-platform", "", "The build platform to use for building")
+	buildCmd.Flags().String("build-platform", "", "The build platform to use for building (defaults to the current platform)")
 	buildCmd.Flags().BoolP("clean", "c", false, "Whether to clean the build directory before building")
-	buildCmd.Flags().String("concurrent-downloads", "", "Max concurrent network requests")
-	buildCmd.Flags().String("concurrent-solves", "", "Max concurrent solves")
-	buildCmd.Flags().Bool("frozen", false, "Install the environment as defined in the lockfile")
-	buildCmd.Flags().Bool("locked", false, "Check if lockfile is up-to-date before installing the environment")
+	buildCmd.Flags().String("concurrent-downloads", "", "Max concurrent network requests, default is `50`")
+	buildCmd.Flags().String("concurrent-solves", "", "Max concurrent solves, default is the number of CPUs")
+	buildCmd.Flags().Bool("frozen", false, "Install the environment as defined in the lockfile, doesn't update lockfile if it isn't up-to-date with the manifest file")
+	buildCmd.Flags().Bool("locked", false, "Check if lockfile is up-to-date before installing the environment, aborts when lockfile isn't up-to-date with the manifest file")
 	buildCmd.Flags().Bool("no-install", false, "Don't modify the environment, only modify the lock-file")
-	buildCmd.Flags().Bool("no-lockfile-update", false, "Skips lock-file updates")
 	buildCmd.Flags().StringP("output-dir", "o", "", "The output directory to place the built artifacts")
-	buildCmd.Flags().String("path", "", "The path to a directory containing a package manifest")
+	buildCmd.Flags().String("path", "", "The path to a directory containing a package manifest, or to a specific manifest file")
 	buildCmd.Flags().String("pinning-strategy", "", "Set pinning strategy")
-	buildCmd.Flags().String("pypi-keyring-provider", "", "Specifies whether to use the keyring for PyPI")
-	buildCmd.Flags().Bool("run-post-link-scripts", false, "Run post-link scripts")
-	buildCmd.Flags().StringP("target-platform", "t", "", "The target platform to build for")
+	buildCmd.Flags().String("pypi-keyring-provider", "", "Specifies whether to use the keyring to look up credentials for PyPI")
+	buildCmd.Flags().Bool("run-post-link-scripts", false, "Run post-link scripts (insecure)")
+	buildCmd.Flags().StringP("target-platform", "t", "", "The target platform to build for (defaults to the current platform)")
 	buildCmd.Flags().Bool("tls-no-verify", false, "Do not verify the TLS certificate of the server")
-	buildCmd.Flags().String("tls-root-certs", "", "Which TLS root certificates to use")
-	buildCmd.Flags().Bool("use-environment-activation-cache", false, "Use environment activation cache")
+	buildCmd.Flags().String("tls-root-certs", "", "Which TLS root certificates to use: 'webpki' (bundled Mozilla roots), 'native' (system store), or 'all' (both)")
+	buildCmd.Flags().Bool("use-environment-activation-cache", false, "Use environment activation cache (experimental)")
 	rootCmd.AddCommand(buildCmd)
 
 	carapace.Gen(buildCmd).FlagCompletion(carapace.ActionMap{

completers/common/pixi_completer/cmd/clean.go

@@ -18,11 +18,9 @@ func init() {
 	cleanCmd.Flags().Bool("activation-cache", false, "Only remove the activation cache")
 	cleanCmd.Flags().Bool("build", false, "Only remove the pixi-build cache")
 	cleanCmd.Flags().StringP("environment", "e", "", "The environment directory to remove")
-	cleanCmd.Flags().StringP("manifest-path", "m", "", "The path to pixi.toml, pyproject.toml, or the workspace directory")
 	rootCmd.AddCommand(cleanCmd)
 
 	carapace.Gen(cleanCmd).FlagCompletion(carapace.ActionMap{
-		"environment":   pixi.ActionEnvironments(),
-		"manifest-path": carapace.ActionFiles(),
+		"environment": pixi.ActionEnvironments(),
 	})
 }

completers/common/pixi_completer/cmd/clean_cache.go

@@ -14,18 +14,15 @@ var clean_cacheCmd = &cobra.Command{
 func init() {
 	carapace.Gen(clean_cacheCmd).Standalone()
 
+	clean_cacheCmd.Flags().Bool("assume-yes", false, "Answer yes to all questions")
 	clean_cacheCmd.Flags().Bool("build", false, "Clean only the build related cache")
 	clean_cacheCmd.Flags().Bool("build-backends", false, "Clean only the build backends environments cache")
 	clean_cacheCmd.Flags().Bool("conda", false, "Clean only the conda related cache")
-	clean_cacheCmd.Flags().Bool("exec", false, "Clean only exec cache")
-	clean_cacheCmd.Flags().StringP("manifest-path", "m", "", "The path to pixi.toml, pyproject.toml, or the workspace directory")
+	clean_cacheCmd.Flags().Bool("exec", false, "Clean only `exec` cache")
 	clean_cacheCmd.Flags().Bool("mapping", false, "Clean only the mapping cache")
 	clean_cacheCmd.Flags().Bool("pypi", false, "Clean only the pypi related cache")
 	clean_cacheCmd.Flags().Bool("repodata", false, "Clean only the repodata cache")
 	clean_cacheCmd.Flags().BoolP("yes", "y", false, "Answer yes to all questions")
+	clean_cacheCmd.Flag("assume-yes").Hidden = true
 	cleanCmd.AddCommand(clean_cacheCmd)
-
-	carapace.Gen(clean_cacheCmd).FlagCompletion(carapace.ActionMap{
-		"manifest-path": carapace.ActionFiles(),
-	})
 }

completers/common/pixi_completer/cmd/clean_help.go

@@ -0,0 +1,18 @@
+package cmd
+
+import (
+	"github.com/carapace-sh/carapace"
+	"github.com/spf13/cobra"
+)
+
+var clean_helpCmd = &cobra.Command{
+	Use:   "help",
+	Short: "Print this message or the help of the given subcommand(s)",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(clean_helpCmd).Standalone()
+
+	cleanCmd.AddCommand(clean_helpCmd)
+}