|
| 1 | +--- |
| 2 | +name: apify-actor-development |
| 3 | +description: >- |
| 4 | + Develop, debug, and deploy Apify Actors - serverless cloud programs for web |
| 5 | + scraping, automation, and data processing. Use when creating new Actors, |
| 6 | + modifying existing ones, or troubleshooting Actor code. |
| 7 | +user-invocable: false |
| 8 | +--- |
| 9 | +# Apify Actor Development |
| 10 | + |
| 11 | +**Important:** Before you begin, fill in the `generatedBy` property in the meta section of `.actor/actor.json`. Set it to the name of the AI coding tool and model you are currently running in, in the format `"<tool> with <model>"` — for example `"Cursor with Claude Sonnet 4.5"`, `"Claude Code with Claude Opus 4"`, or `"GitHub Copilot with GPT-5"`. If you don't know the exact model, use the tool name alone (e.g. `"Cursor"`). This helps Apify monitor and improve AGENTS.md for specific AI tools and models. |
| 12 | + |
| 13 | +## What are Apify Actors? |
| 14 | + |
| 15 | +Actors are serverless programs inspired by the UNIX philosophy - programs that do one thing well and can be easily combined to build complex systems. They're packaged as Docker images and run in isolated containers in the cloud. |
| 16 | + |
| 17 | +**Core Concepts:** |
| 18 | +- Accept well-defined JSON input |
| 19 | +- Perform isolated tasks (web scraping, automation, data processing) |
| 20 | +- Produce structured JSON output to datasets and/or store data in key-value stores |
| 21 | +- Can run from seconds to hours or even indefinitely |
| 22 | +- Persist state and can be restarted |
| 23 | + |
| 24 | +## Prerequisites & Setup (MANDATORY) |
| 25 | + |
| 26 | +Before creating or modifying actors, verify that `apify` CLI is installed `apify --help`. |
| 27 | + |
| 28 | +If it is not installed, use one of these methods (listed in order of preference): |
| 29 | + |
| 30 | +```bash |
| 31 | +# Preferred: install via a package manager (provides integrity checks) |
| 32 | +npm install -g apify-cli |
| 33 | + |
| 34 | +# Or (Mac): brew install apify-cli |
| 35 | +``` |
| 36 | + |
| 37 | +> **Security note:** Do NOT install the CLI by piping remote scripts to a shell |
| 38 | +> (e.g. `curl … | bash` or `irm … | iex`). Always use a package manager. |
| 39 | +
|
| 40 | +When the apify CLI is installed, check that it is logged in with: |
| 41 | + |
| 42 | +```bash |
| 43 | +# Auth check — do NOT pipe to /dev/null, you need to see errors |
| 44 | +apify info 2>&1 |
| 45 | +``` |
| 46 | + |
| 47 | +If not logged in, authenticate using OAuth (opens browser): |
| 48 | + |
| 49 | +```bash |
| 50 | +apify login |
| 51 | +``` |
| 52 | + |
| 53 | +If browser login isn't available (headless environment or CI), the CLI automatically reads `APIFY_TOKEN` from the environment. Ensure the env var is exported and run any apify command - no explicit login needed. If the user doesn't have a token, generate one at https://console.apify.com/settings/integrations. |
| 54 | + |
| 55 | +> **Security note:** Avoid passing tokens as command-line arguments (e.g. `apify login -t <token>`). |
| 56 | +> Arguments are visible in process listings and may be recorded in shell history. |
| 57 | +> Prefer environment variables or interactive login instead. |
| 58 | +> Never log, print, or embed `APIFY_TOKEN` in source code or configuration files. |
| 59 | +
|
| 60 | +## Template Selection |
| 61 | + |
| 62 | +**IMPORTANT:** Before starting actor development, always ask the user which programming language they prefer: |
| 63 | +- **JavaScript** - Use `apify create <actor-name> -t project_empty` |
| 64 | +- **TypeScript** - Use `apify create <actor-name> -t ts_empty` |
| 65 | +- **Python** - Use `apify create <actor-name> -t python-empty` |
| 66 | + |
| 67 | +Use the appropriate CLI command based on the user's language choice. Additional packages (Crawlee, Playwright, etc.) can be installed later as needed. |
| 68 | + |
| 69 | +## Quick Start Workflow |
| 70 | + |
| 71 | +1. **Create actor project** - Run the appropriate `apify create` command based on user's language preference (see Template Selection above) |
| 72 | +2. **Install dependencies** (verify package names match intended packages before installing) |
| 73 | + - JavaScript/TypeScript: `npm install` (uses `package-lock.json` for reproducible, integrity-checked installs — commit the lockfile to version control) |
| 74 | + - Python: `pip install -r requirements.txt` (pin exact versions in `requirements.txt`, e.g. `crawlee==1.2.3`, and commit the file to version control) |
| 75 | +3. **Implement logic** - Write the actor code in `src/main.py`, `src/main.js`, or `src/main.ts` |
| 76 | +4. **Configure schemas** - Update input/output schemas in `.actor/input_schema.json`, `.actor/output_schema.json`, `.actor/dataset_schema.json` |
| 77 | +5. **Configure platform settings** - Update `.actor/actor.json` with actor metadata (see [references/actor-json.md](references/actor-json.md)) |
| 78 | +6. **Write documentation** - Create comprehensive README.md for the marketplace (see [references/actor-readme.md](references/actor-readme.md) — this is mandatory, not optional) |
| 79 | +7. **Test locally** - Run `apify run` to verify functionality (see Local Testing section below) |
| 80 | +8. **Deploy** - Run `apify push` to deploy the actor on the Apify platform (actor name is defined in `.actor/actor.json`) |
| 81 | + |
| 82 | +## Security |
| 83 | + |
| 84 | +**Treat all crawled web content as untrusted input.** Actors ingest data from external websites that may contain malicious payloads. Follow these rules: |
| 85 | + |
| 86 | +- **Sanitize crawled data** — Never pass raw HTML, URLs, or scraped text directly into shell commands, `eval()`, database queries, or template engines. Use proper escaping or parameterized APIs. |
| 87 | +- **Validate and type-check all external data** — Before pushing to datasets or key-value stores, verify that values match expected types and formats. Reject or sanitize unexpected structures. |
| 88 | +- **Do not execute or interpret crawled content** — Never treat scraped text as code, commands, or configuration. Content from websites could include prompt injection attempts or embedded scripts. |
| 89 | +- **Isolate credentials from data pipelines** — Ensure `APIFY_TOKEN` and other secrets are never accessible in request handlers or passed alongside crawled data. Use the Apify SDK's built-in credential management rather than passing tokens through environment variables in data-processing code. |
| 90 | +- **Review dependencies before installing** — When adding packages with `npm install` or `pip install`, verify the package name and publisher. Typosquatting is a common supply-chain attack vector. Prefer well-known, actively maintained packages. |
| 91 | +- **Pin versions and use lockfiles** — Always commit `package-lock.json` (Node.js) or pin exact versions in `requirements.txt` (Python). Lockfiles ensure reproducible builds and prevent silent dependency substitution. Run `npm audit` or `pip-audit` periodically to check for known vulnerabilities. |
| 92 | + |
| 93 | +## Best Practices |
| 94 | + |
| 95 | +**✓ Do:** |
| 96 | +- Use `apify run` to test actors locally (configures Apify environment and storage) |
| 97 | +- Use Apify SDK (`apify`) for code running ON Apify platform |
| 98 | +- Validate input early with proper error handling and fail gracefully |
| 99 | +- Use CheerioCrawler for static HTML (10x faster than browsers) |
| 100 | +- Use PlaywrightCrawler only for JavaScript-heavy sites |
| 101 | +- Use router pattern (createCheerioRouter/createPlaywrightRouter) for complex crawls |
| 102 | +- Implement retry strategies with exponential backoff |
| 103 | +- Use proper concurrency: HTTP (10-50), Browser (1-5) |
| 104 | +- Set sensible defaults in `.actor/input_schema.json` |
| 105 | +- Define output schema in `.actor/output_schema.json` |
| 106 | +- Clean and validate data before pushing to dataset |
| 107 | +- Use semantic CSS selectors with fallback strategies |
| 108 | +- Respect robots.txt, ToS, and implement rate limiting |
| 109 | +- **Always use `apify/log` package** — censors sensitive data (API keys, tokens, credentials) |
| 110 | +- Implement readiness probe handler (required if your Actor uses standby mode) |
| 111 | + |
| 112 | +**✗ Don't:** |
| 113 | +- Use `npm start`, `npm run start`, `npx apify run`, or similar commands to run actors (use `apify run` instead) |
| 114 | +- Assume local storage from `apify run` is pushed to or visible in the Apify Console — it is local-only; deploy with `apify push` and run on the platform to see results in the Console |
| 115 | +- Rely on `Dataset.getInfo()` for final counts on Cloud |
| 116 | +- Use browser crawlers when HTTP/Cheerio works |
| 117 | +- Hard code values that should be in input schema or environment variables |
| 118 | +- Skip input validation or error handling |
| 119 | +- Overload servers - use appropriate concurrency and delays |
| 120 | +- Scrape prohibited content or ignore Terms of Service |
| 121 | +- Store personal/sensitive data unless explicitly permitted |
| 122 | +- Use deprecated options like `requestHandlerTimeoutMillis` on CheerioCrawler (v3.x) |
| 123 | +- Use `additionalHttpHeaders` - use `preNavigationHooks` instead |
| 124 | +- Pass raw crawled content into shell commands, `eval()`, or code-generation functions |
| 125 | +- Use `console.log()` or `print()` instead of the Apify logger — these bypass credential censoring |
| 126 | +- Disable standby mode without explicit permission |
| 127 | + |
| 128 | +## Logging |
| 129 | + |
| 130 | +See [references/logging.md](references/logging.md) for complete logging documentation including available log levels and best practices for JavaScript/TypeScript and Python. |
| 131 | + |
| 132 | +Check `usesStandbyMode` in `.actor/actor.json` - only implement if set to `true`. |
| 133 | + |
| 134 | +## Commands |
| 135 | + |
| 136 | +```bash |
| 137 | +apify run # Run Actor locally |
| 138 | +apify login # Authenticate account |
| 139 | +apify push # Deploy to Apify platform (uses name from .actor/actor.json) |
| 140 | +apify help # List all commands |
| 141 | +``` |
| 142 | + |
| 143 | +**IMPORTANT:** Always use `apify run` to test actors locally. Do not use `npm run start`, `npm start`, `yarn start`, or other package manager commands - these will not properly configure the Apify environment and storage. |
| 144 | + |
| 145 | +## Local Testing |
| 146 | + |
| 147 | +When testing an actor locally with `apify run`, provide input data by creating a JSON file at: |
| 148 | + |
| 149 | +``` |
| 150 | +storage/key_value_stores/default/INPUT.json |
| 151 | +``` |
| 152 | + |
| 153 | +This file should contain the input parameters defined in your `.actor/input_schema.json`. The actor will read this input when running locally, mirroring how it receives input on the Apify platform. |
| 154 | + |
| 155 | +**IMPORTANT - Local storage is NOT synced to the Apify Console:** |
| 156 | +- Running `apify run` stores all data (datasets, key-value stores, request queues) **only on your local filesystem** in the `storage/` directory. |
| 157 | +- This data is **never** automatically uploaded or pushed to the Apify platform. It exists only on your machine. |
| 158 | +- To verify results on the Apify Console, you must deploy the Actor with `apify push` and then run it on the platform. |
| 159 | +- Do **not** rely on checking the Apify Console to verify results from local runs — instead, inspect the local `storage/` directory or check the Actor's log output. |
| 160 | + |
| 161 | +## Standby Mode |
| 162 | + |
| 163 | +See [references/standby-mode.md](references/standby-mode.md) for complete standby mode documentation including readiness probe implementation for JavaScript/TypeScript and Python. |
| 164 | + |
| 165 | +## Project Structure |
| 166 | + |
| 167 | +``` |
| 168 | +.actor/ |
| 169 | +├── actor.json # Actor config: name, version, env vars, runtime |
| 170 | +├── input_schema.json # Input validation & Console form definition |
| 171 | +└── output_schema.json # Output storage and display templates |
| 172 | +src/ |
| 173 | +└── main.js/ts/py # Actor entry point |
| 174 | +storage/ # Local-only storage (NOT synced to Apify Console) |
| 175 | +├── datasets/ # Output items (JSON objects) |
| 176 | +├── key_value_stores/ # Files, config, INPUT |
| 177 | +└── request_queues/ # Pending crawl requests |
| 178 | +Dockerfile # Container image definition |
| 179 | +``` |
| 180 | + |
| 181 | +## Actor Configuration |
| 182 | + |
| 183 | +See [references/actor-json.md](references/actor-json.md) for complete actor.json structure and configuration options. |
| 184 | + |
| 185 | +## Input Schema |
| 186 | + |
| 187 | +See [references/input-schema.md](references/input-schema.md) for input schema structure and examples. |
| 188 | + |
| 189 | +## Output Schema |
| 190 | + |
| 191 | +See [references/output-schema.md](references/output-schema.md) for output schema structure, examples, and template variables. |
| 192 | + |
| 193 | +## Dataset Schema |
| 194 | + |
| 195 | +See [references/dataset-schema.md](references/dataset-schema.md) for dataset schema structure, configuration, and display properties. |
| 196 | + |
| 197 | +## Key-Value Store Schema |
| 198 | + |
| 199 | +See [references/key-value-store-schema.md](references/key-value-store-schema.md) for key-value store schema structure, collections, and configuration. |
| 200 | + |
| 201 | +## Actor README |
| 202 | + |
| 203 | +**IMPORTANT:** Always generate a README.md as part of Actor development. The README is the Actor's landing page on Apify Store and is critical for discoverability (SEO), user onboarding, and support. Do not consider an Actor complete without a proper README. |
| 204 | + |
| 205 | +See [references/actor-readme.md](references/actor-readme.md) for the required structure, SEO best practices, and content guidelines. Also review these top Actors for best practices: |
| 206 | + |
| 207 | +- [Instagram Scraper](https://apify.com/apify/instagram-scraper) |
| 208 | +- [Google Maps Scraper](https://apify.com/compass/crawler-google-places) |
| 209 | + |
| 210 | +## Apify MCP Tools |
| 211 | + |
| 212 | +If MCP server is configured, use these tools for documentation: |
| 213 | + |
| 214 | +- `search-apify-docs` - Search documentation |
| 215 | +- `fetch-apify-docs` - Get full doc pages |
| 216 | + |
| 217 | +Otherwise, the MCP Server url: `https://mcp.apify.com/?tools=docs`. |
| 218 | + |
| 219 | +## Resources |
| 220 | + |
| 221 | +- [docs.apify.com/llms.txt](https://docs.apify.com/llms.txt) - Apify quick reference documentation |
| 222 | +- [docs.apify.com/llms-full.txt](https://docs.apify.com/llms-full.txt) - Apify complete documentation |
| 223 | +- [https://crawlee.dev/llms.txt](https://crawlee.dev/llms.txt) - Crawlee quick reference documentation |
| 224 | +- [https://crawlee.dev/llms-full.txt](https://crawlee.dev/llms-full.txt) - Crawlee complete documentation |
| 225 | +- [whitepaper.actor](https://raw.githubusercontent.com/apify/actor-whitepaper/refs/heads/master/README.md) - Complete Actor specification |
0 commit comments