Adds refernce for CLI Docs

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "files.exclude": {
+    "**/.git": false
+  }
+}

README.md

@@ -44,6 +44,14 @@ yarn lint
 
 This will check the documentation for any issues or inconsistencies based on the defined linting rules.
 
+## Update runpodctl docs
+
+The CLI reference documentation for runpodctl are configured by using the `runpodctl-docs.py` file.
+
+```bash
+python3 runpodctl-docs.py
+```
+
 ## Creating a New Version
 
 Versioning is crucial for tracking changes and releases.

runpodctl-docs.py

@@ -0,0 +1,70 @@
+import os
+import subprocess
+import glob
+from datetime import datetime
+
+
+# Function to run shell commands
+def run_command(command):
+    process = subprocess.Popen(
+        command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE
+    )
+    out, err = process.communicate()
+    if process.returncode != 0:
+        print(f"Error: {err}")
+    return out.decode().strip()
+
+
+# Function to generate metadata header
+def generate_metadata_header(title, slug):
+    current_time = datetime.utcnow().strftime(
+        "%a %b %d %Y %H:%M:%S GMT+0000 (Coordinated Universal Time)"
+    )
+    return f'---\ntitle: "{title}"\nslug: {slug}\nexcerpt: "{title}"\ncategory: "References"\nhidden: false\nmetadata: \n  image: []\n  robots: "index"\ncreatedAt: "{current_time}"\nupdatedAt: "{current_time}"\n---\n\n'
+
+
+# 1. Check if Git module already exists and add if not
+print("Checking for existing Git module...")
+module_path = "runpodctl"
+if not os.path.exists(module_path):
+    print("Adding Git module...")
+    run_command("gh repo clone runpod/runpodctl runpodctl")
+else:
+    print("Git module already exists. Skipping addition.")
+
+# 2. Move Markdown files
+print("Moving Markdown files...")
+source_dir = "runpodctl/doc/"
+target_dir = "v1.0/References/runpodctl/"
+os.makedirs(target_dir, exist_ok=True)
+for md_file in glob.glob(f"{source_dir}*.md"):
+    os.rename(md_file, f"{target_dir}{os.path.basename(md_file)}")
+
+# 3. Update each Markdown file
+print("Editing Markdown files...")
+for md_file in glob.glob(f"{target_dir}*.md"):
+    title = (
+        os.path.basename(md_file)
+        .replace("runpodctl", "")
+        .replace(".md", "")
+        .replace("-", " ")
+        .replace("_", " ")
+        .strip()
+        .title()
+    )
+    if title == "":
+        title = "Runpodctl"
+    slug = os.path.basename(md_file).replace(".md", "").replace("_", "-")
+    with open(md_file, "r") as file:
+        lines = file.readlines()
+    with open(md_file, "w") as file:
+        file.write(generate_metadata_header(title, slug))
+        for line in lines:
+            if "###### Auto generated by" not in line:
+                file.write(line)
+
+# 4. Clean up
+print("Cleaning up...")
+run_command("rm -rf runpodctl")
+
+print("Script completed.")

v1.0/References/runpodctl/runpodctl.md

@@ -0,0 +1,39 @@
+---
+title: "Runpodctl"
+slug: runpodctl
+excerpt: "Runpodctl"
+category: "References"
+hidden: false
+metadata:
+  image: []
+  robots: "index"
+createdAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+updatedAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+---
+
+## runpodctl
+
+runpodctl for runpod.io
+
+### Synopsis
+
+runpodctl is a CLI tool to manage your pods for runpod.io
+
+### Options
+
+```
+  -h, --help   help for runpodctl
+```
+
+### SEE ALSO
+
+* [runpodctl config](runpodctl_config.md)	 - CLI Config
+* [runpodctl create](runpodctl_create.md)	 - create a resource
+* [runpodctl get](runpodctl_get.md)	 - get resource
+* [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 start](runpodctl_start.md)	 - start a resource
+* [runpodctl stop](runpodctl_stop.md)	 - stop a resource
+* [runpodctl version](runpodctl_version.md)	 - runpodctl version
+

v1.0/References/runpodctl/runpodctl_config.md

@@ -0,0 +1,37 @@
+---
+title: "Config"
+slug: runpodctl-config
+excerpt: "Config"
+category: "References"
+hidden: false
+metadata: 
+  image: []
+  robots: "index"
+createdAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+updatedAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+---
+
+## runpodctl config
+
+CLI Config
+
+### Synopsis
+
+RunPod CLI Config Settings
+
+```
+runpodctl config [flags]
+```
+
+### Options
+
+```
+      --apiKey string   runpod api key
+      --apiUrl string   runpod api url
+  -h, --help            help for config
+```
+
+### SEE ALSO
+
+* [runpodctl](runpodctl.md)	 - runpodctl for runpod.io
+

v1.0/References/runpodctl/runpodctl_create.md

@@ -0,0 +1,33 @@
+---
+title: "Create"
+slug: runpodctl-create
+excerpt: "Create"
+category: "References"
+hidden: false
+metadata: 
+  image: []
+  robots: "index"
+createdAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+updatedAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+---
+
+## runpodctl create
+
+create a resource
+
+### Synopsis
+
+create a resource in runpod.io
+
+### Options
+
+```
+  -h, --help   help for create
+```
+
+### SEE ALSO
+
+* [runpodctl](runpodctl.md)	 - runpodctl for runpod.io
+* [runpodctl create pod](runpodctl_create_pod.md)	 - start a pod
+* [runpodctl create pods](runpodctl_create_pods.md)	 - create a group of pods
+

v1.0/References/runpodctl/runpodctl_create_pod.md

@@ -0,0 +1,51 @@
+---
+title: "Create Pod"
+slug: runpodctl-create-pod
+excerpt: "Create Pod"
+category: "References"
+hidden: false
+metadata: 
+  image: []
+  robots: "index"
+createdAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+updatedAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+---
+
+## runpodctl create pod
+
+start a pod
+
+### Synopsis
+
+start a pod from runpod.io
+
+```
+runpodctl create pod [flags]
+```
+
+### Options
+
+```
+      --args string             container arguments
+      --communityCloud          create in community cloud
+      --containerDiskSize int   container disk size in GB (default 20)
+      --cost float32            $/hr price ceiling, if not defined, pod will be created with lowest price available
+      --env strings             container arguments
+      --gpuCount int            number of GPUs for the pod (default 1)
+      --gpuType string          gpu type id, e.g. 'NVIDIA GeForce RTX 3090'
+  -h, --help                    help for pod
+      --imageName string        container image name
+      --mem int                 minimum system memory needed (default 20)
+      --name string             any pod name for easy reference
+      --ports strings           ports to expose; max only 1 http and 1 tcp allowed; e.g. '8888/http'
+      --secureCloud             create in secure cloud
+      --templateId string       templateId to use with the pod
+      --vcpu int                minimum vCPUs needed (default 1)
+      --volumePath string       container volume path (default "/runpod")
+      --volumeSize int          persistent volume disk size in GB (default 1)
+```
+
+### SEE ALSO
+
+* [runpodctl create](runpodctl_create.md)	 - create a resource
+

v1.0/References/runpodctl/runpodctl_create_pods.md

@@ -0,0 +1,51 @@
+---
+title: "Create Pods"
+slug: runpodctl-create-pods
+excerpt: "Create Pods"
+category: "References"
+hidden: false
+metadata: 
+  image: []
+  robots: "index"
+createdAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+updatedAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+---
+
+## runpodctl create pods
+
+create a group of pods
+
+### Synopsis
+
+create a group of pods on runpod.io
+
+```
+runpodctl create pods [flags]
+```
+
+### Options
+
+```
+      --args string             container arguments
+      --communityCloud          create in community cloud
+      --containerDiskSize int   container disk size in GB (default 20)
+      --cost float32            $/hr price ceiling, if not defined, pod will be created with lowest price available
+      --env strings             container arguments
+      --gpuCount int            number of GPUs for the pod (default 1)
+      --gpuType string          gpu type id, e.g. 'NVIDIA GeForce RTX 3090'
+  -h, --help                    help for pods
+      --imageName string        container image name
+      --mem int                 minimum system memory needed (default 20)
+      --name string             any pod name for easy reference
+      --podCount int            number of pods to create with the same name (default 1)
+      --ports strings           ports to expose; max only 1 http and 1 tcp allowed; e.g. '8888/http'
+      --secureCloud             create in secure cloud
+      --vcpu int                minimum vCPUs needed (default 1)
+      --volumePath string       container volume path (default "/runpod")
+      --volumeSize int          persistent volume disk size in GB (default 1)
+```
+
+### SEE ALSO
+
+* [runpodctl create](runpodctl_create.md)	 - create a resource
+

v1.0/References/runpodctl/runpodctl_get.md

@@ -0,0 +1,33 @@
+---
+title: "Get"
+slug: runpodctl-get
+excerpt: "Get"
+category: "References"
+hidden: false
+metadata: 
+  image: []
+  robots: "index"
+createdAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+updatedAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+---
+
+## runpodctl get
+
+get resource
+
+### Synopsis
+
+get resources for pods
+
+### Options
+
+```
+  -h, --help   help for get
+```
+
+### SEE ALSO
+
+* [runpodctl](runpodctl.md)	 - runpodctl for runpod.io
+* [runpodctl get cloud](runpodctl_get_cloud.md)	 - get all cloud gpus
+* [runpodctl get pod](runpodctl_get_pod.md)	 - get all pods
+

v1.0/References/runpodctl/runpodctl_get_cloud.md

@@ -0,0 +1,40 @@
+---
+title: "Get Cloud"
+slug: runpodctl-get-cloud
+excerpt: "Get Cloud"
+category: "References"
+hidden: false
+metadata: 
+  image: []
+  robots: "index"
+createdAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+updatedAt: "Fri Dec 29 2023 18:27:25 GMT+0000 (Coordinated Universal Time)"
+---
+
+## runpodctl get cloud
+
+get all cloud gpus
+
+### Synopsis
+
+get all cloud gpus available on runpod.io
+
+```
+runpodctl get cloud [gpuCount] [flags]
+```
+
+### Options
+
+```
+  -c, --community   show listings from community cloud only
+      --disk int    minimum disk size in GB you need
+  -h, --help        help for cloud
+      --mem int     minimum sys memory size in GB you need
+  -s, --secure      show listings from secure cloud only
+      --vcpu int    minimum vCPUs you need
+```
+
+### SEE ALSO
+
+* [runpodctl get](runpodctl_get.md)	 - get resource
+