musenn/finrpa-enterprise/skyvern

pip install skyvern
export SKYVERN_API_KEY="YOUR_KEY"   # get one at https://app.skyvern.com
skyvern init                        # optional -- configures local env

# 1. Create a cloud session (timeout in minutes, default 60)
skyvern browser session create --timeout 30
 
# 2. Navigate (uses the active session automatically)
skyvern browser navigate --url "https://example.com"
 
# 3. Do work (act, extract, click, etc.)
skyvern browser act --prompt "Click the Sign In button"
 
# 4. Verify with screenshot
skyvern browser screenshot
 
# 5. Close when done
skyvern browser session close

# List all sessions
skyvern browser session list
 
# Get details for a specific session
skyvern browser session get --session pbs_123
 
# Connect to an existing session (cloud or CDP)
skyvern browser session connect --session pbs_123
skyvern browser session connect --cdp "ws://localhost:9222"
 
# Close a specific session
skyvern browser session close --session pbs_123

# 1. Create a session
skyvern browser session create
 
# 2. Run the task (uses active session automatically)
skyvern browser run-task \
  --prompt "Go to the pricing page and extract all plan names and prices" \
  --url "https://example.com" \
  --schema '{"type":"object","properties":{"plans":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"type":"string"}}}}}}'
 
# 3. Close session when done
skyvern browser session close

# Navigate to the source page
skyvern browser navigate --url "https://example.com/products"
 
# Extract structured data with a JSON schema
skyvern browser extract \
  --prompt "Extract all product names and prices from the listing" \
  --schema '{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"price":{"type":"string"}},"required":["name"]}}},"required":["items"]}'

# Page 1
skyvern browser extract --prompt "Extract all product rows"
# Check for next page
skyvern browser validate --prompt "Is there a Next page button that is not disabled?"
# If true, advance
skyvern browser act --prompt "Click the Next page button"
# Repeat extraction

skyvern browser act \
  --prompt "Fill the contact form: first name John, last name Doe, email john@example.com, then click Submit"

# Type into a field (by intent)
skyvern browser type --text "John" --intent "the first name input"
 
# Type into a field (by selector)
skyvern browser type --text "john@example.com" --selector "#email"
 
# Click a button (by intent)
skyvern browser click --intent "the Submit button"
 
# Select a dropdown option
skyvern browser select --value "US" --intent "the country dropdown"
skyvern browser select --value "California" --selector "#state" --by-label
 
# Press a key
skyvern browser press-key --key "Enter"
 
# Hover to reveal a menu
skyvern browser hover --intent "the Account menu"

# Create a credential (prompts for password securely via stdin)
skyvern credentials add --name "prod-salesforce" --type password --username "user@co.com"

# List credentials to find the ID
skyvern credential list
 
# Create session and navigate to login page
skyvern browser session create
skyvern browser navigate --url "https://login.salesforce.com"
 
# Log in with stored credentials (AI handles the full login flow)
skyvern browser login --url "https://login.salesforce.com" --credential-id cred_123
 
# Verify login succeeded
skyvern browser validate --prompt "Is the user logged in? Look for a dashboard or user avatar."
skyvern browser screenshot

# Password credential
skyvern credentials add --name "my-login" --type password --username "user"
 
# Credit card credential
skyvern credentials add --name "my-card" --type credit_card
 
# Secret credential (API key, token, etc.)
skyvern credentials add --name "my-secret" --type secret

# Create from a YAML or JSON file
skyvern workflow create --definition @workflow.yaml
 
# Create from inline JSON
skyvern workflow create --definition '{"title":"My Workflow","workflow_definition":{"parameters":[],"blocks":[{"block_type":"navigation","label":"step1","url":"https://example.com","navigation_goal":"Click the pricing link"}]}}'
 
# Specify format explicitly
skyvern workflow create --definition @workflow.json --format json

# Basic run
skyvern workflow run --id wpid_123
 
# With parameters (inline JSON or @file)
skyvern workflow run --id wpid_123 --params '{"email":"user@co.com","name":"John"}'
skyvern workflow run --id wpid_123 --params @params.json
 
# Wait for completion
skyvern workflow run --id wpid_123 --wait --timeout 600
 
# With proxy and webhook
skyvern workflow run --id wpid_123 --proxy RESIDENTIAL --webhook "https://hooks.example.com/done"
 
# Reuse an existing browser session
skyvern workflow run --id wpid_123 --session pbs_456

# Check run status
skyvern workflow status --run-id wr_789
 
# Cancel a run
skyvern workflow cancel --run-id wr_789
 
# List workflows (with search and pagination)
skyvern workflow list --search "invoice" --page 1 --page-size 20
skyvern workflow list --only-workflows  # exclude saved tasks
 
# Get workflow definition
skyvern workflow get --id wpid_123 --version 2
 
# Update a workflow
skyvern workflow update --id wpid_123 --definition @updated.yaml
 
# Delete a workflow
skyvern workflow delete --id wpid_123 --force

created -> queued -> running -> completed | failed | canceled | terminated | timed_out

# List all block types
skyvern block schema
 
# Get schema for a specific type
skyvern block schema --type navigation
 
# Validate a block definition
skyvern block validate --block-json '{"block_type":"navigation","label":"step1","url":"https://example.com","navigation_goal":"Click pricing"}'
skyvern block validate --block-json @block.json