fix: moved doc to docs

runpod · Feb 6, 2024 · 73b6290 · 73b6290
1 parent 4c90f4b
commit 73b6290
Show file tree

Hide file tree

Showing 33 changed files with 214 additions and 143 deletions.
diff --git a/doc/runpodctl_project.md b/doc/runpodctl_project.md
diff --git a/doc/runpodctl_project_build.md b/doc/runpodctl_project_build.md
diff --git a/doc/runpodctl_project_deploy.md b/doc/runpodctl_project_deploy.md
diff --git a/doc/runpodctl_project_dev.md b/doc/runpodctl_project_dev.md
diff --git a/doc/runpodctl_project_new.md b/doc/runpodctl_project_new.md
diff --git a/doc/gen.go → docs/docs-gen.go b/doc/gen.go → docs/docs-gen.go
@@ -8,7 +8,8 @@ import (
 )
 
 func main() {
-	err := doc.GenMarkdownTree(cmd.RootCmd, "./doc/")
+	rootCmd := cmd.GetRootCmd()
+	err := doc.GenMarkdownTree(rootCmd, "./docs/")
 	if err != nil {
 		log.Fatal(err)
 	}

diff --git a/doc/runpodctl.md → docs/runpodctl.md b/doc/runpodctl.md → docs/runpodctl.md
@@ -17,13 +17,14 @@ CLI tool to manage your pods for runpod.io
 * [runpodctl config](runpodctl_config.md)	 - CLI Config
 * [runpodctl create](runpodctl_create.md)	 - create a resource
 * [runpodctl get](runpodctl_get.md)	 - get resource
-* [runpodctl project](runpodctl_project.md)	 - manage projects
+* [runpodctl project](runpodctl_project.md)	 - Manage RunPod projects
 * [runpodctl receive](runpodctl_receive.md)	 - receive file(s), or folder
 * [runpodctl remove](runpodctl_remove.md)	 - remove a resource
 * [runpodctl send](runpodctl_send.md)	 - send file(s), or folder
+* [runpodctl ssh](runpodctl_ssh.md)	 - SSH keys and commands
 * [runpodctl start](runpodctl_start.md)	 - start a resource
 * [runpodctl stop](runpodctl_stop.md)	 - stop a resource
 * [runpodctl update](runpodctl_update.md)	 - update runpodctl
 * [runpodctl version](runpodctl_version.md)	 - runpodctl version
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_config.md → docs/runpodctl_config.md b/doc/runpodctl_config.md → docs/runpodctl_config.md
@@ -13,13 +13,13 @@ runpodctl config [flags]
 ### Options
 
 ```
-      --apiKey string   runpod api key
-      --apiUrl string   runpod api url
+      --apiKey string   RunPod API key
+      --apiUrl string   RunPod API URL (default "https://api.runpod.io/graphql")
   -h, --help            help for config
 ```
 
 ### SEE ALSO
 
 * [runpodctl](runpodctl.md)	 - CLI for runpod.io
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_create.md → docs/runpodctl_create.md b/doc/runpodctl_create.md → docs/runpodctl_create.md
@@ -18,4 +18,4 @@ create a resource in runpod.io
 * [runpodctl create pod](runpodctl_create_pod.md)	 - start a pod
 * [runpodctl create pods](runpodctl_create_pods.md)	 - create a group of pods
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_create_pod.md → docs/runpodctl_create_pod.md b/doc/runpodctl_create_pod.md → docs/runpodctl_create_pod.md
@@ -36,4 +36,4 @@ runpodctl create pod [flags]
 
 * [runpodctl create](runpodctl_create.md)	 - create a resource
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_create_pods.md → docs/runpodctl_create_pods.md b/doc/runpodctl_create_pods.md → docs/runpodctl_create_pods.md
@@ -36,4 +36,4 @@ runpodctl create pods [flags]
 
 * [runpodctl create](runpodctl_create.md)	 - create a resource
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_get.md → docs/runpodctl_get.md b/doc/runpodctl_get.md → docs/runpodctl_get.md
@@ -18,4 +18,4 @@ get resources for pods
 * [runpodctl get cloud](runpodctl_get_cloud.md)	 - get all cloud gpus
 * [runpodctl get pod](runpodctl_get_pod.md)	 - get all pods
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_get_cloud.md → docs/runpodctl_get_cloud.md b/doc/runpodctl_get_cloud.md → docs/runpodctl_get_cloud.md
@@ -25,4 +25,4 @@ runpodctl get cloud [gpuCount] [flags]
 
 * [runpodctl get](runpodctl_get.md)	 - get resource
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_get_pod.md → docs/runpodctl_get_pod.md b/doc/runpodctl_get_pod.md → docs/runpodctl_get_pod.md
@@ -21,4 +21,4 @@ runpodctl get pod [podId] [flags]
 
 * [runpodctl get](runpodctl_get.md)	 - get resource
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/docs/runpodctl_project.md b/docs/runpodctl_project.md
@@ -0,0 +1,23 @@
+## runpodctl project
+
+Manage RunPod projects
+
+### Synopsis
+
+Develop and deploy projects entirely on RunPod's infrastructure
+
+### Options
+
+```
+  -h, --help   help for project
+```
+
+### SEE ALSO
+
+* [runpodctl](runpodctl.md)	 - CLI for runpod.io
+* [runpodctl project build](runpodctl_project_build.md)	 - builds Dockerfile for current project
+* [runpodctl project create](runpodctl_project_create.md)	 - creates a new project
+* [runpodctl project deploy](runpodctl_project_deploy.md)	 - deploys your project as an endpoint
+* [runpodctl project dev](runpodctl_project_dev.md)	 - starts a development session for the current project
+
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/docs/runpodctl_project_build.md b/docs/runpodctl_project_build.md
@@ -0,0 +1,24 @@
+## runpodctl project build
+
+builds Dockerfile for current project
+
+### Synopsis
+
+builds a local Dockerfile for the project in the current folder. You can use this Dockerfile to build an image and deploy it to any API server.
+
+```
+runpodctl project build [flags]
+```
+
+### Options
+
+```
+  -h, --help          help for build
+      --include-env   include environment variables from runpod.toml in generated Dockerfile
+```
+
+### SEE ALSO
+
+* [runpodctl project](runpodctl_project.md)	 - Manage RunPod projects
+
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/docs/runpodctl_project_create.md b/docs/runpodctl_project_create.md
@@ -0,0 +1,25 @@
+## runpodctl project create
+
+creates a new project
+
+### Synopsis
+
+creates a new RunPod project folder on your local machine
+
+```
+runpodctl project create [flags]
+```
+
+### Options
+
+```
+  -h, --help          help for create
+  -i, --init          use the current directory as the project directory
+  -n, --name string   project name
+```
+
+### SEE ALSO
+
+* [runpodctl project](runpodctl_project.md)	 - Manage RunPod projects
+
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/docs/runpodctl_project_deploy.md b/docs/runpodctl_project_deploy.md
@@ -0,0 +1,23 @@
+## runpodctl project deploy
+
+deploys your project as an endpoint
+
+### Synopsis
+
+deploys a serverless endpoint for the RunPod project in the current folder
+
+```
+runpodctl project deploy [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for deploy
+```
+
+### SEE ALSO
+
+* [runpodctl project](runpodctl_project.md)	 - Manage RunPod projects
+
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/docs/runpodctl_project_dev.md b/docs/runpodctl_project_dev.md
@@ -0,0 +1,25 @@
+## runpodctl project dev
+
+starts a development session for the current project
+
+### Synopsis
+
+connects your local environment and the project environment on your Pod. Changes propagate to the project environment in real time.
+
+```
+runpodctl project dev [flags]
+```
+
+### Options
+
+```
+  -h, --help              help for dev
+      --prefix-pod-logs   prefix logs from project Pod with Pod ID (default true)
+      --select-volume     select a new default network volume for current project
+```
+
+### SEE ALSO
+
+* [runpodctl project](runpodctl_project.md)	 - Manage RunPod projects
+
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_receive.md → docs/runpodctl_receive.md b/doc/runpodctl_receive.md → docs/runpodctl_receive.md
@@ -20,4 +20,4 @@ runpodctl receive [code] [flags]
 
 * [runpodctl](runpodctl.md)	 - CLI for runpod.io
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_remove.md → docs/runpodctl_remove.md b/doc/runpodctl_remove.md → docs/runpodctl_remove.md
@@ -18,4 +18,4 @@ remove a resource in runpod.io
 * [runpodctl remove pod](runpodctl_remove_pod.md)	 - remove a pod
 * [runpodctl remove pods](runpodctl_remove_pods.md)	 - remove all pods using name
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_remove_pod.md → docs/runpodctl_remove_pod.md b/doc/runpodctl_remove_pod.md → docs/runpodctl_remove_pod.md
@@ -20,4 +20,4 @@ runpodctl remove pod [podId] [flags]
 
 * [runpodctl remove](runpodctl_remove.md)	 - remove a resource
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_remove_pods.md → docs/runpodctl_remove_pods.md b/doc/runpodctl_remove_pods.md → docs/runpodctl_remove_pods.md
@@ -21,4 +21,4 @@ runpodctl remove pods [name] [flags]
 
 * [runpodctl remove](runpodctl_remove.md)	 - remove a resource
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/doc/runpodctl_send.md → docs/runpodctl_send.md b/doc/runpodctl_send.md → docs/runpodctl_send.md
@@ -21,4 +21,4 @@ runpodctl send [filename(s) or folder] [flags]
 
 * [runpodctl](runpodctl.md)	 - CLI for runpod.io
 
-###### Auto generated by spf13/cobra on 28-Jan-2024
+###### Auto generated by spf13/cobra on 6-Feb-2024
diff --git a/docs/runpodctl_ssh.md b/docs/runpodctl_ssh.md
@@ -0,0 +1,21 @@
+## runpodctl ssh
+
+SSH keys and commands
+
+### Synopsis
+
+SSH key management and connection to pods
+
+### Options
+
+```
+  -h, --help   help for ssh
+```
+
+### SEE ALSO
+
+* [runpodctl](runpodctl.md)	 - CLI for runpod.io
+* [runpodctl ssh add-key](runpodctl_ssh_add-key.md)	 - Adds an SSH key to the current user account
+* [runpodctl ssh list-keys](runpodctl_ssh_list-keys.md)	 - List all SSH keys
+
+###### Auto generated by spf13/cobra on 6-Feb-2024