Awesome-omni-skill apify-actorization
Convert existing projects into Apify Actors - serverless cloud programs. Actorize JavaScript/TypeScript (SDK with Actor.init/exit), Python (async context manager), or any language (CLI wrapper). Us...
git clone https://github.com/diegosouzapw/awesome-omni-skill
T=$(mktemp -d) && git clone --depth=1 https://github.com/diegosouzapw/awesome-omni-skill "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/backend/apify-actorization" ~/.claude/skills/diegosouzapw-awesome-omni-skill-apify-actorization && rm -rf "$T"
skills/backend/apify-actorization/SKILL.md- curl piped into shell
- global npm install
- pip install
- makes HTTP requests (curl)
Apify Actorization
Actorization converts existing software into reusable serverless applications compatible with the Apify platform. Actors are programs packaged as Docker images that accept well-defined JSON input, perform an action, and optionally produce structured JSON output.
Quick Start
- Run
in project rootapify init - Wrap code with SDK lifecycle (see language-specific section below)
- Configure
.actor/input_schema.json - Test with
apify run --input '{"key": "value"}' - Deploy with
apify push
When to Use This Skill
- Converting an existing project to run on Apify platform
- Adding Apify SDK integration to a project
- Wrapping a CLI tool or script as an Actor
- Migrating a Crawlee project to Apify
Prerequisites
Verify
apify CLI is installed:
apify --help
If not installed:
curl -fsSL https://apify.com/install-cli.sh | bash # Or (Mac): brew install apify-cli # Or (Windows): irm https://apify.com/install-cli.ps1 | iex # Or: npm install -g apify-cli
Verify CLI is logged in:
apify info # Should return your username
If not logged in, check if
APIFY_TOKEN environment variable is defined. If not, ask the user to generate one at https://console.apify.com/settings/integrations, then:
apify login -t $APIFY_TOKEN
Actorization Checklist
Copy this checklist to track progress:
- Step 1: Analyze project (language, entry point, inputs, outputs)
- Step 2: Run
to create Actor structureapify init - Step 3: Apply language-specific SDK integration
- Step 4: Configure
.actor/input_schema.json - Step 5: Configure
(if applicable).actor/output_schema.json - Step 6: Update
metadata.actor/actor.json - Step 7: Test locally with
apify run - Step 8: Deploy with
apify push
Step 1: Analyze the Project
Before making changes, understand the project:
- Identify the language - JavaScript/TypeScript, Python, or other
- Find the entry point - The main file that starts execution
- Identify inputs - Command-line arguments, environment variables, config files
- Identify outputs - Files, console output, API responses
- Check for state - Does it need to persist data between runs?
Step 2: Initialize Actor Structure
Run in the project root:
apify init
This creates:
- Actor configuration and metadata.actor/actor.json
- Input definition for the Apify Console.actor/input_schema.json
(if not present) - Container image definitionDockerfile
Step 3: Apply Language-Specific Changes
Choose based on your project's language:
- JavaScript/TypeScript: See js-ts-actorization.md
- Python: See python-actorization.md
- Other Languages (CLI-based): See cli-actorization.md
Quick Reference
| Language | Install | Wrap Code |
|---|---|---|
| JS/TS | | ... |
| Python | | |
| Other | Use CLI in wrapper script | / |
Steps 4-6: Configure Schemas
See schemas-and-output.md for detailed configuration of:
- Input schema (
).actor/input_schema.json - Output schema (
).actor/output_schema.json - Actor configuration (
).actor/actor.json - State management (request queues, key-value stores)
Validate schemas against
@apify/json_schemas npm package.
Step 7: Test Locally
Run the actor with inline input (for JS/TS and Python actors):
apify run --input '{"startUrl": "https://example.com", "maxItems": 10}'
Or use an input file:
apify run --input-file ./test-input.json
Important: Always use
apify run, not npm start or python main.py. The CLI sets up the proper environment and storage.
Step 8: Deploy
apify push
This uploads and builds your actor on the Apify platform.
Monetization (Optional)
After deploying, you can monetize your actor in the Apify Store. The recommended model is Pay Per Event (PPE):
- Per result/item scraped
- Per page processed
- Per API call made
Configure PPE in the Apify Console under Actor > Monetization. Charge for events in your code with
await Actor.charge('result').
Other options: Rental (monthly subscription) or Free (open source).
Pre-Deployment Checklist
-
exists with correct name and description.actor/actor.json -
validates against.actor/actor.json
(@apify/json_schemas
)actor.schema.json -
defines all required inputs.actor/input_schema.json -
validates against.actor/input_schema.json
(@apify/json_schemas
)input.schema.json -
defines output structure (if applicable).actor/output_schema.json -
validates against.actor/output_schema.json
(@apify/json_schemas
)output.schema.json -
is present and builds successfullyDockerfile -
/Actor.init()
wraps main code (JS/TS)Actor.exit() -
wraps main code (Python)async with Actor: - Inputs are read via
/Actor.getInput()Actor.get_input() - Outputs use
or key-value storeActor.pushData() -
executes successfully with test inputapify run -
is set in actor.json meta sectiongeneratedBy
Apify MCP Tools
If MCP server is configured, use these tools for documentation:
- Search documentationsearch-apify-docs
- Get full doc pagesfetch-apify-docs
Otherwise, the MCP Server url:
https://mcp.apify.com/?tools=docs.
Resources
- Actorization Academy - Comprehensive guide
- Apify SDK for JavaScript - Full SDK reference
- Apify SDK for Python - Full SDK reference
- Apify CLI Reference - CLI commands
- Actor Specification - Complete specification