Merge pull request #69 from ArthurFlag/update-dmr-docs

docs: update dmr cmds

Author: xenoscopic

commands/install-runner.go

@@ -113,7 +113,7 @@ func newInstallRunner() *cobra.Command {
 	var gpuMode string
 	c := &cobra.Command{
 		Use:   "install-runner",
-		Short: "Install Docker Model Runner",
+		Short: "Install Docker Model Runner (Docker Engine only)",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			// Ensure that we're running in a supported model runner context.
 			engineKind := modelRunner.EngineKind()

commands/list.go

@@ -19,7 +19,7 @@ func newListCmd() *cobra.Command {
 	c := &cobra.Command{
 		Use:     "list [OPTIONS]",
 		Aliases: []string{"ls"},
-		Short:   "List the available models that can be run with the Docker Model Runner",
+		Short:   "List the models pulled to your local environment",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if openai && quiet {
 				return fmt.Errorf("--quiet flag cannot be used with --openai flag")

commands/logs.go

@@ -142,8 +142,8 @@ func newLogsCmd() *cobra.Command {
 		},
 		ValidArgsFunction: completion.NoComplete,
 	}
-	c.Flags().BoolVarP(&follow, "follow", "f", false, "Follow log output")
-	c.Flags().BoolVar(&noEngines, "no-engines", false, "Skip inference engines logs")
+	c.Flags().BoolVarP(&follow, "follow", "f", false, "View logs with real-time streaming")
+	c.Flags().BoolVar(&noEngines, "no-engines", false, "Exclude inference engine logs from the output")
 	return c
 }
 

commands/package.go

@@ -19,7 +19,7 @@ func newPackagedCmd() *cobra.Command {
 
 	c := &cobra.Command{
 		Use:   "package --gguf <path> [--license <path>...] --push TARGET",
-		Short: "package a model",
+		Short: "Package a GGUF file into a Docker model OCI artifact, with optional licenses, and pushes it to the specified registry",
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) != 1 {
 				return fmt.Errorf(

commands/pull.go

@@ -11,7 +11,7 @@ import (
 func newPullCmd() *cobra.Command {
 	c := &cobra.Command{
 		Use:   "pull MODEL",
-		Short: "Download a model",
+		Short: "Pull a model from Docker Hub or HuggingFace to your local environment",
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) != 1 {
 				return fmt.Errorf(

commands/push.go

@@ -11,7 +11,7 @@ import (
 func newPushCmd() *cobra.Command {
 	c := &cobra.Command{
 		Use:   "push MODEL",
-		Short: "Upload a model",
+		Short: "Push a model to Docker Hub",
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) != 1 {
 				return fmt.Errorf(

commands/rm.go

@@ -12,7 +12,7 @@ func newRemoveCmd() *cobra.Command {
 
 	c := &cobra.Command{
 		Use:   "rm [MODEL...]",
-		Short: "Remove models downloaded from Docker Hub",
+		Short: "Remove local models downloaded from Docker Hub",
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) < 1 {
 				return fmt.Errorf(

commands/run.go

@@ -18,7 +18,7 @@ func newRunCmd() *cobra.Command {
 	cmdArgs := "MODEL [PROMPT]"
 	c := &cobra.Command{
 		Use:   "run " + cmdArgs,
-		Short: "Run a model with the Docker Model Runner",
+		Short: "Run a model and interact with it using a submitted prompt or chat mode",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			model := args[0]
 			prompt := ""

desktop/context.go

@@ -98,9 +98,9 @@ const (
 func (k ModelRunnerEngineKind) String() string {
 	switch k {
 	case ModelRunnerEngineKindMoby:
-		return "Moby"
+		return "Docker Engine"
 	case ModelRunnerEngineKindMobyManual:
-		return "Moby (Manual Install)"
+		return "Docker Engine (Manual Install)"
 	case ModelRunnerEngineKindDesktop:
 		return "Docker Desktop"
 	case ModelRunnerEngineKindCloud:

docs/reference/docker_model.yaml

@@ -1,6 +1,8 @@
 command: docker model
 short: Docker Model Runner
-long: Docker Model Runner
+long: |-
+    Use Docker Model Runner to run and interact with AI models directly from the command line.
+    For more information, see the [documentation](/model-runner/)
 pname: docker
 plink: docker.yaml
 cname: