Skip to content

Commit 58d59f8

Browse files
committed
chore: tweaks
1 parent 7beaa7d commit 58d59f8

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

agents.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file contains instructions for AI agents working on the Apify CLI project t
44

55
## Project Overview
66

7-
The Apify CLI is a command-line interface that helps developers create, develop, build, and run Apify Actors, and manage the Apify cloud platform. It's built with TypeScript and uses a modular command framework.
7+
The Apify CLI is a command-line interface that helps developers create, develop, build, and run Apify Actors, and manage their Actors on the Apify cloud platform. It's built with TypeScript and uses a modular command framework.
88

99
## Command Development Guidelines
1010

@@ -34,21 +34,21 @@ When creating new CLI commands, follow these guidelines:
3434

3535
```typescript
3636
export class MyCommandCommand extends ApifyCommand<typeof MyCommandCommand> {
37-
static override name = "my-command" as const;
38-
39-
static override description = "Description of what this command does";
40-
41-
static override args = {
42-
// Define arguments here using Args.*
43-
};
44-
45-
static override flags = {
46-
// Define flags here using Flags.*
47-
};
48-
49-
async run() {
50-
// Command logic implementation
51-
}
37+
static override name = "my-command" as const;
38+
39+
static override description = "Description of what this command does";
40+
41+
static override args = {
42+
// Define arguments here using Args.*
43+
};
44+
45+
static override flags = {
46+
// Define flags here using Flags.*
47+
};
48+
49+
async run() {
50+
// Command logic implementation
51+
}
5252
}
5353
```
5454

@@ -83,14 +83,13 @@ Study these existing commands for patterns and best practices:
8383

8484
### Error Handling
8585

86-
- Use appropriate exit error codes from `src/lib/consts.ts`
86+
- Use appropriate exit error codes from `src/lib/consts.ts`
8787
- Provide helpful error messages to users
8888
- Handle edge cases gracefully
8989

9090
### Configuration
9191

9292
- Actor configuration uses `.actor/actor.json` (new format)
93-
- Legacy `apify.json` is deprecated but may need migration support
9493
- Reference constants from `src/lib/consts.ts` for file paths and configurations
9594

9695
## Testing
@@ -105,7 +104,7 @@ Study these existing commands for patterns and best practices:
105104
2. Lint code: `yarn lint` or `yarn lint:fix`
106105
3. Format code: `yarn format` or `yarn format:fix`
107106
4. Build project: `yarn build`
108-
5. Run tests: `yarn test:local` or `yarn test:all`
107+
5. Run tests: `yarn test:local`
109108

110109
## Important Notes
111110

0 commit comments

Comments
 (0)