Skip to content

Commit cca96d0

Browse files
TC-MOclaude
TC-MO
and
claude
authored
docs: fix title case > sentence case (#1044)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent cbfd62a commit cca96d0

5 files changed

Lines changed: 257 additions & 265 deletions

File tree

‎docs/reference.md‎

Lines changed: 105 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Apify CLI Reference Documentation
2+
title: Command reference
33
sidebar_label: Command reference
44
toc_max_heading_level: 5
55
---
@@ -79,7 +79,7 @@ USAGE
7979
<!-- general-commands-end -->
8080
<!-- prettier-ignore-end -->
8181

82-
### Authentication & Account Management
82+
### Authentication & Account management
8383

8484
Use these commands to manage your Apify account authentication, access tokens, and configuration settings. These commands control how you interact with Apify platform and manage sensitive information.
8585

@@ -223,9 +223,9 @@ ARGUMENTS
223223
<!-- auth-commands-end -->
224224
<!-- prettier-ignore-end -->
225225
226-
### Actor Development
226+
### Actor development
227227
228-
These commands help you develop Actors locally. Use them to create new Actor projects, initialize configurations, run Actors in development mode, and validate input schemas.
228+
These commands help you develop Actors locally. Use them to create new Actor projects, initialize configurations, run Actors in development mode, and validate input schemas. This section also includes commands used within running Actors to interact with the Apify platform, such as reading input, storing values, and pushing data.
229229
230230
<!-- prettier-ignore-start -->
231231
<!-- actor-dev-commands-start -->
@@ -299,31 +299,35 @@ DESCRIPTION
299299
in package.json file.
300300

301301
USAGE
302-
$ apify run [--entrypoint <value>]
302+
$ apify run [--allow-missing-secrets] [--entrypoint <value>]
303303
[-i <value> | --input-file <value>] [-p | --resurrect]
304304

305305
FLAGS
306-
--entrypoint=<value> Optional entrypoint for running
307-
with injected environment variables.
308-
For Python, it is the module name, or a path to a file.
309-
For Node.js, it is the npm script name, or a path to a
310-
JS/MJS file. You can also pass in a directory name,
311-
provided that directory contains an "index.js" file.
312-
-i, --input=<value> Optional JSON input to be
313-
given to the Actor.
314-
--input-file=<value> Optional path to a file with JSON
315-
input to be given to the Actor. The file must be a valid
316-
JSON file. You can also specify `-` to read from
317-
standard input.
318-
-p, --purge Whether to purge the default
319-
request queue, dataset and key-value store before the
320-
run starts.
321-
For crawlee projects, this is the default behavior, and
322-
the flag is optional.
323-
Use `--no-purge` to keep the storage folder intact.
324-
--resurrect Whether to keep the default
325-
request queue, dataset and key-value store before the
326-
run starts.
306+
--allow-missing-secrets Allow the command to
307+
continue even when secret values are not found in the
308+
local secrets storage.
309+
--entrypoint=<value> Optional entrypoint for
310+
running with injected environment variables.
311+
For Python, it is the module name, or a path to a
312+
file.
313+
For Node.js, it is the npm script name, or a path to
314+
a JS/MJS file. You can also pass in a directory name,
315+
provided that directory contains an "index.js" file.
316+
-i, --input=<value> Optional JSON input to
317+
be given to the Actor.
318+
--input-file=<value> Optional path to a file with
319+
JSON input to be given to the Actor. The file must be
320+
a valid JSON file. You can also specify `-` to read
321+
from standard input.
322+
-p, --purge Whether to purge the
323+
default request queue, dataset and key-value store
324+
before the run starts.
325+
For crawlee projects, this is the default behavior,
326+
and the flag is optional.
327+
Use `--no-purge` to keep the storage folder intact.
328+
--resurrect Whether to keep the default
329+
request queue, dataset and key-value store before the
330+
run starts.
327331
```
328332
329333
##### `apify validate-schema`
@@ -345,72 +349,6 @@ ARGUMENTS
345349
path Optional path to your INPUT_SCHEMA.json file. If not provided
346350
./INPUT_SCHEMA.json is used.
347351
```
348-
<!-- actor-dev-commands-end -->
349-
<!-- prettier-ignore-end -->
350-
351-
### Actor Management
352-
353-
These commands let you manage Actors on Apify platform. They provide functionality for deployment, execution, monitoring, and maintenance of your Actors in the cloud environment.
354-
355-
#### Basic Actor Operations
356-
357-
Use these commands to handle core Actor operations like creation, listing, deletion, and basic runtime management. These are the essential commands for working with Actors on Apify platform.
358-
359-
<!-- prettier-ignore-start -->
360-
<!-- actor-basic-commands-start -->
361-
##### `apify actors`
362-
363-
```sh
364-
DESCRIPTION
365-
Manages Actor creation, deployment, and execution on the Apify platform.
366-
367-
SUBCOMMANDS
368-
actors start Starts Actor remotely and returns run details
369-
immediately.
370-
actors rm Permanently removes an Actor from your account.
371-
actors push Deploys Actor to Apify platform using settings from
372-
'.actor/actor.json'.
373-
actors pull Download Actor code to current directory. Clones Git
374-
repositories or fetches Actor files based on the source type.
375-
actors ls Prints a list of recently executed Actors or Actors
376-
you own.
377-
actors info Get information about an Actor.
378-
actors call Executes Actor remotely using your authenticated
379-
account.
380-
actors build Creates a new build of the Actor.
381-
```
382-
383-
##### `apify actors ls`
384-
385-
```sh
386-
DESCRIPTION
387-
Prints a list of recently executed Actors or Actors you own.
388-
389-
USAGE
390-
$ apify actors ls [--desc] [--json] [--limit <value>] [--my]
391-
[--offset <value>]
392-
393-
FLAGS
394-
--desc Sort Actors in descending order.
395-
--json Format the command output as JSON
396-
--limit=<value> Number of Actors that will be listed.
397-
--my Whether to list Actors made by the logged
398-
in user.
399-
--offset=<value> Number of Actors that will be skipped.
400-
```
401-
402-
##### `apify actors rm`
403-
404-
```sh
405-
DESCRIPTION
406-
Permanently removes an Actor from your account.
407-
408-
USAGE
409-
$ apify actors rm <actorId>
410-
411-
ARGUMENTS
412-
actorId The Actor ID to delete.
413-
```
414352
415353
##### `apify actor`
416354
@@ -620,10 +558,72 @@ FLAGS
620558
content type of the record. By default
621559
"application/json" is used.
622560
```
561+
<!-- actor-dev-commands-end -->
562+
<!-- prettier-ignore-end -->
563+
564+
### Actor management
565+
566+
These commands let you manage Actors on Apify platform. They provide functionality for deployment, execution, monitoring, and maintenance of your Actors in the cloud environment.
567+
568+
<!-- prettier-ignore-start -->
569+
<!-- actor-basic-commands-start -->
570+
##### `apify actors`
571+
572+
```sh
573+
DESCRIPTION
574+
Manages Actor creation, deployment, and execution on the Apify platform.
575+
576+
SUBCOMMANDS
577+
actors start Starts Actor remotely and returns run details
578+
immediately.
579+
actors rm Permanently removes an Actor from your account.
580+
actors push Deploys Actor to Apify platform using settings from
581+
'.actor/actor.json'.
582+
actors pull Download Actor code to current directory. Clones Git
583+
repositories or fetches Actor files based on the source type.
584+
actors ls Prints a list of recently executed Actors or Actors
585+
you own.
586+
actors info Get information about an Actor.
587+
actors call Executes Actor remotely using your authenticated
588+
account.
589+
actors build Creates a new build of the Actor.
590+
```
591+
592+
##### `apify actors ls`
593+
594+
```sh
595+
DESCRIPTION
596+
Prints a list of recently executed Actors or Actors you own.
597+
598+
USAGE
599+
$ apify actors ls [--desc] [--json] [--limit <value>] [--my]
600+
[--offset <value>]
601+
602+
FLAGS
603+
--desc Sort Actors in descending order.
604+
--json Format the command output as JSON
605+
--limit=<value> Number of Actors that will be listed.
606+
--my Whether to list Actors made by the logged
607+
in user.
608+
--offset=<value> Number of Actors that will be skipped.
609+
```
610+
611+
##### `apify actors rm`
612+
613+
```sh
614+
DESCRIPTION
615+
Permanently removes an Actor from your account.
616+
617+
USAGE
618+
$ apify actors rm <actorId>
619+
620+
ARGUMENTS
621+
actorId The Actor ID to delete.
622+
```
623623
<!-- actor-basic-commands-end -->
624624
<!-- prettier-ignore-end -->
625625
626-
#### Actor Deployment
626+
#### Actor deployment
627627
628628
These commands handle the deployment workflow of Actors to Apify platform. Use them to push local changes, pull remote Actors, and manage Actor versions and builds.
629629
@@ -636,18 +636,24 @@ DESCRIPTION
636636
Deploys Actor to Apify platform using settings from '.actor/actor.json'.
637637
Files under '3' MB upload as "Multiple source files"; larger projects upload
638638
as ZIP file.
639+
Files matched by .gitignore and .actorignore are excluded. Use negation
640+
patterns (e.g. !dist/) in .actorignore to force-include git-ignored files.
639641
Use --force to override newer remote versions.
640642
641643
USAGE
642-
$ apify actors push [actorId] [-b <value>] [--dir <value>]
643-
[-f] [--json] [--open] [-v <value>] [-w <value>]
644+
$ apify actors push [actorId] [--allow-missing-secrets]
645+
[-b <value>] [--dir <value>] [-f] [--json] [--open]
646+
[-v <value>] [-w <value>]
644647
645648
ARGUMENTS
646649
actorId Name or ID of the Actor to push (e.g. "apify/hello-world" or
647650
"E2jjCZBezvAZnX8Rb"). If not provided, the command will create or
648651
modify the Actor with the name specified in '.actor/actor.json' file.
649652
650653
FLAGS
654+
--allow-missing-secrets Allow the command to
655+
continue even when secret values are not found in
656+
the local secrets storage.
651657
-b, --build-tag=<value> Build tag to be
652658
applied to the successful Actor build. By default,
653659
it is taken from the '.actor/actor.json' file
@@ -783,7 +789,7 @@ FLAGS
783789
<!-- actor-deploy-commands-end -->
784790
<!-- prettier-ignore-end -->
785791
786-
#### Actor Builds
792+
#### Actor builds
787793
788794
Use these commands to manage Actor build processes. They help you create, monitor, and maintain versioned snapshots of your Actors that can be executed on Apify platform.
789795
@@ -927,7 +933,7 @@ ARGUMENTS
927933
<!-- actor-build-commands-end -->
928934
<!-- prettier-ignore-end -->
929935
930-
#### Actor Runs
936+
#### Actor runs
931937
932938
These commands control Actor execution on Apify platform. Use them to start, monitor, and manage Actor runs, including accessing logs and handling execution states.
933939
@@ -1202,7 +1208,7 @@ ARGUMENTS
12021208
<!-- dataset-commands-end -->
12031209
<!-- prettier-ignore-end -->
12041210
1205-
#### Key-Value Stores
1211+
#### Key-value stores
12061212
12071213
These commands handle key-value store operations. Use them to create stores, manage key-value pairs, and handle persistent storage of arbitrary data types.
12081214
@@ -1410,7 +1416,7 @@ FLAGS
14101416
<!-- keyval-commands-end -->
14111417
<!-- prettier-ignore-end -->
14121418
1413-
#### Request Queues
1419+
#### Request queues
14141420
14151421
These commands manage request queues, which handle URL processing for web scraping and automation tasks. Use them to maintain lists of URLs with automatic retry mechanisms and state management.
14161422

‎scripts/generate-cli-docs.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,6 @@ const categories: Record<string, CommandsInCategory[]> = {
2424
{ command: Commands.init },
2525
{ command: Commands.run },
2626
{ command: Commands.validateSchema },
27-
],
28-
'actor-basic': [
29-
//
30-
{ command: Commands.actors },
31-
{ command: Commands.actorsLs },
32-
{ command: Commands.actorsRm },
3327

3428
{ command: Commands.actor },
3529
{ command: Commands.actorCalculateMemory },
@@ -41,6 +35,12 @@ const categories: Record<string, CommandsInCategory[]> = {
4135
{ command: Commands.actorPushData },
4236
{ command: Commands.actorSetValue },
4337
],
38+
'actor-basic': [
39+
//
40+
{ command: Commands.actors },
41+
{ command: Commands.actorsLs },
42+
{ command: Commands.actorsRm },
43+
],
4444
'actor-deploy': [
4545
//
4646
{ command: Commands.actorsPush, aliases: [Commands.push] },

0 commit comments

Comments
 (0)