Add example to koyeb cp

koyeb · Feb 22, 2024 · b4f8932 · b4f8932
1 parent c9cd214
commit b4f8932
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/docs/reference.md b/docs/reference.md
@@ -1875,6 +1875,16 @@ Copy files and directories to and from instances.
 koyeb instances cp SRC DST [flags]
 ```
 
+### Examples
+
+```
+
+# To copy the file hello.txt, located in your working directory on your machine to a remote koyeb instance, in the /tmp/ directory
+$> koyeb instance cp hello.txt <instance_id>:/tmp/
+# To copy the file spreadsheet.csv, located in /tmp/ in your Instance to the local directory on your machine
+$> koyeb instance cp <instance_id>:/tmp/spreadsheet.csv .
+```
+
 ### Options
 
 ```

diff --git a/pkg/koyeb/instances.go b/pkg/koyeb/instances.go
@@ -52,7 +52,12 @@ func NewInstanceCmd() *cobra.Command {
 		Short:   "Copy files and directories to and from instances.",
 		Aliases: []string{"copy"},
 		Args:    cobra.ExactArgs(2),
-		RunE:    WithCLIContext(instanceHandler.Cp),
+		Example: `
+To copy the file hello.txt, located in your working directory on your machine to a remote koyeb instance, in the /tmp/ directory
+$> koyeb instance cp hello.txt <instance_id>:/tmp/
+To copy the file spreadsheet.csv, located in /tmp/ in your Instance to the local directory on your machine
+$> koyeb instance cp <instance_id>:/tmp/spreadsheet.csv .`,
+		RunE: WithCLIContext(instanceHandler.Cp),
 	}
 	instanceCmd.AddCommand(cpInstanceCmd)