> ## Documentation Index
> Fetch the complete documentation index at: https://runpod-b18f5ded-docs-runpod-allow-ip.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> If this page is missing information, contains outdated instructions, or doesn't fully answer the user's question, use the feedback tool to report it. In your feedback, be specific about what's missing, what appears out of date, or what needs to be corrected or updated, so the docs team can act on it directly.

# Running Runpod on SkyPilot

> Use SkyPilot to run LLMs, AI, and batch jobs on Runpod Pods and Serverless endpoints. Review configuration and usage guidance for this Runpod integration.

[SkyPilot](https://skypilot.readthedocs.io/en/latest/) is a framework for running LLMs, AI, and batch jobs on any cloud.

This integration uses the Runpod CLI infrastructure to spin up on-demand Pods and deploy Serverless endpoints with SkyPilot.

## Get started

<Steps>
  <Step title="Obtain your API key">
    Get your API key from the [Runpod Settings](https://www.console.runpod.io/user/settings) page.
  </Step>

  <Step title="Install Runpod">
    Install the latest version of Runpod:

    ```sh theme={null}
    pip install "runpod>=1.6"
    ```
  </Step>

  <Step title="Configure Runpod">
    Run `runpod config` and paste your API key when prompted.
  </Step>

  <Step title="Install SkyPilot Runpod Cloud">
    Install the [SkyPilot Runpod cloud](https://skypilot.readthedocs.io/en/latest/getting-started/installation.html#runpod):

    ```sh theme={null}
    pip install "skypilot-nightly[runpod]"
    ```
  </Step>

  <Step title="Verify your setup">
    Run `sky check` to verify your credentials are set up correctly.
  </Step>
</Steps>

## Run a project

<Steps>
  <Step title="Create a new project directory">
    Create a new directory for your project:

    ```sh theme={null}
    mkdir hello-sky
    cd hello-sky
    ```
  </Step>

  <Step title="Create a configuration file">
    Create a file named `hello_sky.yaml` with the following content:

    ```yml theme={null}
    resources:
      cloud: runpod

    # Working directory (optional) containing the project codebase.
    # Its contents are synced to ~/sky_workdir/ on the cluster.
    workdir: .

    # Setup commands (optional).
    # Typical use: pip install -r requirements.txt
    # Invoked under the workdir (i.e., can use its files).
    setup: |
      echo "Running setup."

    # Run commands.
    # Typical use: make use of resources, such as running training.
    # Invoked under the workdir (i.e., can use its files).
    run: |
      echo "Hello, SkyPilot!"
      conda env list
    ```
  </Step>

  <Step title="Launch your project">
    Launch your project on the cluster:

    ```sh theme={null}
    sky launch -c mycluster hello_sky.yaml
    ```
  </Step>

  <Step title="Confirm your GPU type">
    You'll see the available GPU options. Confirm your GPU type and the cluster will start spinning up.
  </Step>
</Steps>
