> ## Documentation Index
> Fetch the complete documentation index at: https://antideploy.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Your First App Live in 5 Minutes

> Connect a GitHub repo, upload a folder, or push over the API: Antideploy analyzes your code and deploys it.

Three ways in. All three end at the same place: Antideploy reads your code,
works out what it needs, builds it, and gives you an HTTPS URL.

## Method 1: GitHub

Best when you want every push to redeploy.

<Steps>
  <Step title="Install the GitHub App">
    From the dashboard, choose **Repositories** and install the Antideploy
    GitHub App on the account or organization that owns your repo. Grant it
    access to all repositories, or pick specific ones.
  </Step>

  <Step title="Pick a repository">
    Select the repo you want to deploy. Antideploy fetches it and analyzes it
    immediately.
  </Step>

  <Step title="Review what it found">
    You'll see the detected runtime, framework, build and start commands, port,
    and whether a database is needed, with the evidence for each. Warnings and
    hazards appear here, before anything is built.
  </Step>

  <Step title="Deploy">
    Press **Deploy**. Progress is shown step by step: analyze, build, release,
    health check. When it finishes you get a live HTTPS URL.
  </Step>
</Steps>

Every subsequent push to the default branch redeploys automatically.

## Method 2: Upload a folder

Best when there's no Git repo, or the code isn't on GitHub.

<Steps>
  <Step title="Create a project">
    In the dashboard, choose **New project → Upload**.
  </Step>

  <Step title="Drag your folder in">
    Drop the project folder or a `.zip` onto the upload area. Dependency and
    build directories (`node_modules`, `.git`, `dist`, `.next`) are excluded
    automatically; you don't need to clean the folder first.
  </Step>

  <Step title="Review and deploy">
    Same analysis and same deploy flow as above.
  </Step>
</Steps>

To ship a new version, upload the folder again.

## Method 3: Push over the API

Best for scripts and AI coding agents. There is no CLI to install.

<Steps>
  <Step title="Create a project and copy its key">
    In the dashboard, choose **New project → API**. You get a project API key,
    shown once. It is scoped to that one project.
  </Step>

  <Step title="Push the project directory">
    From your project root:

    ```bash theme={null}
    tar czf - --exclude=.git --exclude=node_modules . |
      curl -X POST https://antideploy.com/api/v1/deploy \
        -H "Authorization: Bearer $ANTIDEPLOY_KEY" \
        -F "archive=@-"
    ```

    <Warning>
      Send the whole directory, not just your entry file. A push containing only
      `index.html` succeeds, deploys, and then serves a page whose scripts,
      styles and images all 404. Check the `files` array in the response: if you
      expected a project and see one file, the upload was wrong.
    </Warning>
  </Step>

  <Step title="Watch it finish">
    The response includes a `taskId` and a `watch` URL. Poll it until `status`
    is `succeeded` or `failed`:

    ```bash theme={null}
    curl https://antideploy.com/api/v1/deployments/$TASK_ID \
      -H "Authorization: Bearer $ANTIDEPLOY_KEY"
    ```
  </Step>
</Steps>

<Note>
  If you're pointing an AI agent at Antideploy, the full API contract is
  readable without a key at `https://antideploy.com/api/v1`. Give the agent that
  URL along with the project key.
</Note>

See [Deploy over the API](/docs/api/deploy) for the complete reference.

## What you get

A live HTTPS URL, a deployment you can roll back, searchable logs, and health
checks that email you if the app goes down.

## Before you rely on it

Antideploy raises **hazards** during analysis for things that will not work
once deployed: files written to local disk, background workers, scheduled
jobs. Read them. They are the difference between "deployed" and "working."