Rewrite runpodctl reference documentation (#454)

Author: muhsinking

docs.json

@@ -339,31 +339,24 @@
         "tab": "CLI",
         "groups": [
           {
-            "group": "Get started",
-            "pages": ["runpodctl/overview", "runpodctl/install-runpodctl"]
+            "group": "Runpod CLI",
+            "pages": ["runpodctl/overview"]
           },
           {
             "group": "Reference",
             "pages": [
-              "runpodctl/reference/runpodctl",
               "runpodctl/reference/runpodctl-config",
-              "runpodctl/reference/runpodctl-create",
               "runpodctl/reference/runpodctl-create-pod",
               "runpodctl/reference/runpodctl-create-pods",
-              "runpodctl/reference/runpodctl-get",
               "runpodctl/reference/runpodctl-get-cloud",
               "runpodctl/reference/runpodctl-get-pod",
               "runpodctl/reference/runpodctl-receive",
-              "runpodctl/reference/runpodctl-remove",
               "runpodctl/reference/runpodctl-remove-pod",
               "runpodctl/reference/runpodctl-remove-pods",
               "runpodctl/reference/runpodctl-send",
-              "runpodctl/reference/runpodctl-ssh",
               "runpodctl/reference/runpodctl-ssh-add-key",
               "runpodctl/reference/runpodctl-ssh-list-keys",
-              "runpodctl/reference/runpodctl-start",
               "runpodctl/reference/runpodctl-start-pod",
-              "runpodctl/reference/runpodctl-stop",
               "runpodctl/reference/runpodctl-stop-pod",
               "runpodctl/reference/runpodctl-update",
               "runpodctl/reference/runpodctl-version"
@@ -478,6 +471,10 @@
   },
 
   "redirects": [        
+    {
+      "source": "/runpodctl/install-runpodctl",
+      "destination": "/runpodctl/overview"
+    },
     {
       "source": "/references/faq",
       "destination": "/references/troubleshooting/zero-gpus"

pods/manage-pods.mdx

@@ -5,7 +5,7 @@ description: "Create, start, stop, and terminate Pods using the Runpod console o
 
 ## Before you begin
 
-If you want to manage Pods using the Runpod CLI, you'll need to [install Runpod CLI](/runpodctl/install-runpodctl), and set your [API key](/get-started/api-keys) in the configuration.
+If you want to manage Pods using the Runpod CLI, you'll need to [install Runpod CLI](/runpodctl/overview), and set your [API key](/get-started/api-keys) in the configuration.
 
 Run the following command, replacing `RUNPOD_API_KEY` with your API key:
 

pods/storage/transfer-files.mdx

@@ -15,16 +15,19 @@ Runpod supports four different file transfer methods, each optimized for specifi
 | **Cloud sync** | Backup, multi-environment sharing | Cloud provider setup | Provider dependent |
 
 ### runpodctl
+
 The simplest option for occasional transfers. Uses secure one-time codes and requires no setup since it's pre-installed on all Pods. Perfect for quick file exchanges.
 
-To install `runpodctl` on your local machine, see the [installation guide](/runpodctl/install-runpodctl).
+To install `runpodctl` on your local machine, see the [installation guide](/runpodctl/overview).
 
 ### SCP
+
 A reliable, standard method that works over SSH. Ideal for users comfortable with command-line tools who need to transfer both individual files and directories.
 
 To configure your Pod for SSH access, see the ([SSH setup guide](/pods/configuration/use-ssh)).
 
 ### rsync
+
 The most powerful option, featuring incremental transfers, compression, and detailed progress reporting. Essential for large datasets, regular synchronization, and preserving file attributes.
 
 To set up `rsync`:
@@ -33,6 +36,7 @@ To set up `rsync`:
 - Ensure your local machine is running a Linux or WSL environment.
 
 ### Cloud sync
+
 Direct synchronization with cloud storage providers like AWS S3, Google Cloud Storage, or Dropbox. Best for creating backups or sharing files across multiple environments.
 
 To learn more, see the [cloud sync configuration guide](/pods/storage/cloud-sync).

runpodctl/install-runpodctl.mdx

@@ -1,75 +1,103 @@
 ---
-title: "Runpod CLI overview"
+title: "Overview"
 sidebarTitle: "Overview"
 ---
 
-Runpod CLI is an [open source](https://github.com/runpod/runpodctl) command-line interface tool that simplifies the management of GPU [Pods](/pods/overview) and [Serverless](/serverless/overview) endpoints on the Runpod platform. You can use Runpod CLI to execute code on Pods, deploy endpoints, transfer data, and manage computing resources efficiently.
+Runpod CLI is an [open source](https://github.com/runpod/runpodctl) command-line interface tool for managing your Runpod resources remotely from your local machine. You can transfer files and data between your local system and Runpod, execute code on remote Pods, and automate Pod deployment workflows.
 
-Every Pod you deploy comes preinstalled with the `runpodctl` command. You can also [install it locally](/runpodctl/install-runpodctl) to manage Runpod resources from your own machine.
+## Install Runpod CLI locally
 
-## Key capabilities
+Every Pod you deploy comes preinstalled with the `runpodctl` command and a Pod-scoped API key. You can also install it on your local machine to manage your Pods remotely from your own system.
 
-Runpod CLI enables you to:
+### Step 1: Choose an installation method
 
-* [Manage Pods](/pods/manage-pods) and Serverless endpoints programmatically.
-* [Transfer files](/pods/storage/transfer-files) and data between your local system and Runpod.
-
-## Installation
-
-For more information, see [Install runpodctl](/runpodctl/install-runpodctl).
+Choose the installation method that matches your operating system.
 
 <Tabs>
-<Tab title="macOS (Homebrew)">
-Install using Homebrew:
+<Tab title="macOS">
 
+**Homebrew:**
 ```sh
 brew install runpod/runpodctl/runpodctl
 ```
 
-</Tab>
+**ARM (Apple Silicon):**
+```sh
+wget --quiet --show-progress https://github.com/runpod/runpodctl/releases/download/v1.14.3/runpodctl-darwin-arm64 -O runpodctl && chmod +x runpodctl && sudo mv runpodctl /usr/local/bin/runpodctl
+```
+
+**AMD (Intel):**
+```sh
+wget --quiet --show-progress https://github.com/runpod/runpodctl/releases/download/v1.14.3/runpodctl-darwin-amd64 -O runpodctl && chmod +x runpodctl && sudo mv runpodctl /usr/local/bin/runpodctl
+```
 
-<Tab title="Linux (WSL)">
-Install using `wget`:
+</Tab>
 
+<Tab title="Linux">
 ```sh
-wget -qO- cli.runpod.net | sudo bash
+wget --quiet --show-progress https://github.com/Run-Pod/runpodctl/releases/download/v1.14.3/runpodctl-linux-amd64 -O runpodctl && chmod +x runpodctl && sudo cp runpodctl /usr/bin/runpodctl
 ```
 
 </Tab>
 
-<Tab title="Windows (PowerShell)">
-Install using PowerShell:
+<Tab title="Windows">
+```sh
+wget https://github.com/runpod/runpodctl/releases/download/v1.14.3/runpodctl-windows-amd64.exe -O runpodctl.exe
+```
 
+</Tab>
+
+<Tab title="Google Colab / Jupyter Notebook">
 ```sh
-wget https://github.com/runpod/runpodctl/releases/latest/download/runpodctl-windows-amd64.exe -O runpodctl.exe
+!wget --quiet --show-progress https://github.com/Run-Pod/runpodctl/releases/download/v1.14.3/runpodctl-linux-amd -O runpodctl
+!chmod +x runpodctl
+!cp runpodctl /usr/bin/runpodctl
 ```
 
 </Tab>
 
 </Tabs>
 
-## Configure your API key
+This installs `runpodctl` globally on your system, so you can run commands from any directory.
+
+### Step 2: Configure your API key
 
-Before you can use Runpod CLI to manage resources from your local machine, you'll need to configure your [API key](/get-started/api-keys). You can create and manage API keys on the [Runpod account settings page](https://www.console.runpod.io/user/settings).
+Before you can use `runpodctl` locally, you must configure it with an [API key](/get-started/api-keys).
 
-After installing `runpodctl` on your local system, run this command to configure it with your API key:
+Run the following command to add your API key to `runpodctl`, replacing `YOUR_API_KEY` with your API key:
 
 ```sh
-runpodctl config --apiKey [API_KEY]
+runpodctl config --apiKey YOUR_API_KEY
 ```
 
-## Help command
+After running the command, you should see a confirmation message similar to this:
+```text
+saved apiKey into config file: /Users/runpod/.runpod/config.toml
+```
+
+### Step 3: Verify installation
 
-Learn how to use Runpod CLI commands by browsing the [CLI reference](/runpodctl/reference/runpodctl) or by running the `help` command:
+To verify that `runpodctl` installed successfully, run this command:
 
 ```sh
-runpodctl help
+runpodctl version
 ```
 
-Learn more about a particular command by running:
+You should see which version is installed:
 
 ```sh
-runpodctl [command] help
+runpodctl v1.14.4
+```
+
+## Help and reference
+
+Learn how to use Runpod CLI commands by browsing the CLI reference using the sidebar to the left, or by running the `help` command:
+
+```sh
+runpodctl help
 ```
 
-For a comprehensive list of commands, see the [Runpod CLI reference](/runpodctl/reference/runpodctl).
+Learn more about a particular command by running:
+```sh
+runpodctl [command] help
+```

runpodctl/overview.mdx

@@ -1,27 +1,34 @@
 ---
-title: "Config"
+title: "config"
+sidebarTitle: "config"
 ---
 
-## runpodctl config
+Configure the Runpod CLI with your API credentials and API URL to enable programmatic access to your Runpod resources.
 
-CLI Config
+```sh
+runpodctl config [flags]
+```
 
-### Synopsis
+## Example
 
-Runpod CLI Config Settings
+Configure the CLI with your API key:
 
 ```sh
-runpodctl config [flags]
+runpodctl config --apiKey rpaPOIUYYULKDSALVIUT3Q2ZRKZ98IUYTSK2OQQ2CWQxkd01
 ```
 
-### Options
+## Flags
 
-```text
-    --apiKey string   Runpod API key
-    --apiUrl string   Runpod API URL (default "https://api.runpod.io/graphql")
--h, --help            help for config
-```
+The following flags are available for the `config` command:
+
+---
+
+`--apiKey <value>` • `string`
+
+Your Runpod API key, which authenticates the CLI to access your account. You can generate an API key from the [Runpod console](https://www.runpod.io/console/user/settings).
+
+---
 
-### SEE ALSO
+`--apiUrl <value>` • `string` • default = `https://api.runpod.io/graphql`
 
-* [runpodctl](/runpodctl/reference/runpodctl) - CLI for runpod.io
+The Runpod API endpoint URL. The default value should work for most users.