nimoqup046-collab/agora / .claude/skills/apify-actorization
apify-actorization
VerifiedActorization 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.
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
apify initin project root - 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:
brew install apify-cli
# Or: npm install -g apify-cli
# Or install from an official release package that your OS package manager verifies
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, add it to their shell or secret manager without putting the literal token in command history, then run:
apify login
Actorization Checklist
Copy this checklist to track progress:
- Step 1: Analyze project (language, entry point, inputs, outputs)
- Step 2: Run
apify initto create Actor structure - Step 3: Apply language-specific SDK integration
- Step 4: Configure
.actor/input_schema.json - Step 5: Configure
.actor/output_schema.json(if applicable) - Step 6: Update
.actor/actor.jsonmetadata - 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/actor.json- Actor configuration and metadata.actor/input_schema.json- Input definition for the Apify ConsoleDockerfile(if not present) - Container image definition
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 | npm install apify | await Actor.init() ... await Actor.exit() |
| Python | pip install apify | async with Actor: |
| Other | Use CLI in wrapper script | apify actor:get-input / apify actor:push-data |
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
-
.actor/actor.jsonexists with correct name and description -
.actor/actor.jsonvalidates against@apify/json_schemas(actor.schema.json) -
.actor/input_schema.jsondefines all required inputs -
.actor/input_schema.jsonvalidates against@apify/json_schemas(input.schema.json) -
.actor/output_schema.jsondefines output structure (if applicable) -
.actor/output_schema.jsonvalidates against@apify/json_schemas(output.schema.json) -
Dockerfileis present and builds successfully -
Actor.init()/Actor.exit()wraps main code (JS/TS) -
async with Actor:wraps main code (Python) - Inputs are read via
Actor.getInput()/Actor.get_input() - Outputs use
Actor.pushData()or key-value store -
apify runexecutes successfully with test input -
generatedByis set in actor.json meta section
Apify MCP Tools
If MCP server is configured, use these tools for documentation:
search-apify-docs- Search documentationfetch-apify-docs- Get full doc pages
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
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deployment | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |
| childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |