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

# Quick Start

> Get up and running with PullUp in 5 minutes

## Installation

### Prerequisites

* Node.js >= 14.0.0
* Playwright skill (for executing tests)

### Setup

**Option A: Install from Marketplace (Recommended)**

```bash theme={null}
# Add skill from marketplace
/plugin marketplace add jaytoday/pullup

# Install plugin
/plugin install pullup@pullup-skill

# Complete setup (install Playwright and Chromium)
cd ~/.claude/plugins/marketplaces/pullup/skills/pullup-skill
npm run setup
```

**Option B: Clone Repository**

Clone or download the repository and install dependencies:

```bash theme={null}
cd pullup/skills/pullup-skill
npm run setup
```

Setup only needs to be run once. It installs Playwright and Chromium browser.

## Create Your First Skill

### Option 1: With Documentation (Recommended)

Create a simple documentation file `app-info.md`:

```markdown theme={null}
# MyApp
http://localhost:3000

## Features
- Login: /login
- Dashboard: /dashboard

## Test User
email: test@example.com
password: testpass123
```

Then run:

```bash theme={null}
node execute.js --name myapp --docs app-info.md
```

### Option 2: Just URL

```bash theme={null}
node execute.js --name myapp --url http://localhost:3000
```

### Option 3: With Guidance

```bash theme={null}
node execute.js --name myapp --docs ./docs \
  --prompt "Focus on admin features"
```

## What Happens Next

PullUp will:

1. **Read** your documentation (if provided)
2. **Explore** your application (10-30 seconds)
3. **Discover** pages, forms, and flows
4. **Generate** a custom skill at `~/.claude/skills/myapp-testing/`

<Tip>
  Provide credentials in your documentation to enable exploration of authenticated areas.
</Tip>

## Using Your Generated Skill

Once created, use it naturally with Claude:

```
"Use myapp-testing to verify the homepage loads"
"Test login using myapp-testing skill"
"Check if product search works in myapp"
```

The skill already knows:

* Application URL
* Page structure
* Form fields
* Expected workflows
* Test credentials

## Update When Needed

As your application changes:

```bash theme={null}
node execute.js --name myapp --update
```

PullUp re-explores and merges new findings with existing knowledge.

## Command Options

All available options:

```bash theme={null}
# With documentation
node execute.js --name <appname> --docs <file-or-folder>

# With prompt/instructions
node execute.js --name <appname> --docs ./docs --prompt "Focus on X"

# Just URL
node execute.js --name <appname> --url <url>

# Update existing
node execute.js --name <appname> --update

# Custom output location
node execute.js --name <appname> --url <url> --output ./skills

# Control exploration
node execute.js --name <appname> --url <url> --max-depth 5 --max-pages 100

# Verbose output
node execute.js --name <appname> --url <url> --verbose
```

## Troubleshooting

<AccordionGroup>
  <Accordion title="Unknown option: ---docs">
    Use two dashes: `--docs` not `---docs`
  </Accordion>

  <Accordion title="Application URL is required">
    Add `--url http://localhost:3000` or include URL in your documentation
  </Accordion>

  <Accordion title="Playwright not found">
    Run setup: `cd skills/pullup-skill && npm run setup`
  </Accordion>

  <Accordion title="Too few pages discovered">
    * Provide credentials in documentation
    * Increase `--max-depth` and `--max-pages`
    * Add important pages to documentation
    * Use `--verbose` to debug
  </Accordion>
</AccordionGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="See Usage Examples" icon="code" href="/usage">
    Learn advanced usage patterns
  </Card>

  <Card title="GitHub Repository" icon="github" href="https://github.com/jaytoday/pullup">
    View source code and examples
  </Card>
</CardGroup>