You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sources/platform/actors/development/quick_start/build_with_ai.md
+9-11Lines changed: 9 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,41 +15,39 @@ import PromptButton from "@site/src/components/PromptButton";
15
15
import InstallMCPButton from "@site/src/components/InstallMCPButton";
16
16
import copyForAI from "./images/copy-for-ai.png";
17
17
18
-
This guide shows you how to build Actors efficiently with AI coding assistants. You'll learn how to use pre-built instructions, integrate Apify documentation into your AI editor, and apply best practices for AI-assisted development.
18
+
You will learn several approaches to building Apify Actors with the help of AI coding assistants. This guide includes independent instructions, tools, and best practices that you can use individually or combine together. Each section focuses on a specific part of the process such as prompt usage, Actor templates, Apify MCP server tools, or documentation integration, so you can follow only the parts that fit your development style.
19
19
20
20
## AI coding assistant instructions
21
21
22
-
Use the following prompt in your AI coding assistant ([Cursor](https://www.cursor.com/), [Claude Code](https://www.claude.com/product/claude-code), [GitHub Copilot](https://github.com/features/copilot), etc.):
22
+
Use the following prompt in your AI coding assistant such as [Cursor](https://www.cursor.com/), [Claude Code](https://www.claude.com/product/claude-code) or [GitHub Copilot](https://github.com/features/copilot):
23
23
24
24
<PromptButtonprompt={AGENTS_PROMPT}title="Use pre-built prompt for your AI coding assistant" />
25
25
26
+
The prompt guides AI coding assistants such as Cursor, Claude Code or GitHub Copilot to help users create and deploy an Apify Actor step by step. It walks through setting up the Actor structure, configuring all required files, installing dependencies, running it locally, logging in, and pushing it to the Apify platform and following Apify’s best practices.
27
+
26
28
### Quick Start
27
29
28
30
-_Step 1_: Create directory: `mkdir my-new-actor`
29
31
-_Step 2_: Open the directory in _Cursor_, _Claude Code_, _VS Code with GitHub Copilot_, etc.
30
32
-_Step 3_: Copy the prompt above and paste it into your AI coding assistant (Agent or Chat)
31
33
-_Step 4_: Run it, and develop your first actor with the help of AI
32
34
33
-
:::info Start in an AI coding assistant
35
+
:::info Avoid copy-pasting
34
36
35
-
Copy the prompt directly to your AI coding assistant (such as Cursor or VS Code with GitHub Copilot) to maximize efficiency.. The AI will follow the guide step-by-step, and you'll avoid copy-pasting from tools like ChatGPT or Claude.
37
+
The AI will follow the guide step-by-step, and you'll avoid copy-pasting from tools like ChatGPT or Claude.
36
38
37
39
:::
38
40
39
41
## Use Actor templates with AGENTS.md
40
42
41
-
All [Actor Templates](https://apify.com/templates) have AGENTS.md that will help you with AI coding. If you prefer a more traditional approach, run the following command:
42
-
43
-
:::info Install Apify CLI
44
-
45
-
If you don't have Apify CLI installed, install it first. Check the [installation guide](/cli/docs/installation).
46
-
47
-
:::
43
+
All [Actor Templates](https://apify.com/templates) have AGENTS.md that will help you with AI coding. You can use the [Apify CLI](/cli/docs) to create Actors from Actor Templates.
48
44
49
45
```bash
50
46
apify create
51
47
```
52
48
49
+
If you do not have Apify CLI installed, see the [installation guide](/cli/docs/installation).
50
+
53
51
The command above will guide you through Apify Actor initialization, where you select an Actor Template that works for you. The result is an initialized Actor (with AGENTS.md) ready for development.
0 commit comments