@@ -14,7 +14,65 @@ The general commands provide basic functionality for getting help and informatio
1414
1515<!-- prettier-ignore-start -->
1616<!-- general-commands-start -->
17+ ##### ` apify help `
1718
19+ ``` sh
20+ DESCRIPTION
21+ Prints out help about a command, or all available commands.
22+
23+ USAGE
24+ $ apify help [commandString]
25+
26+ ARGUMENTS
27+ commandString The command to get help for.
28+ ```
29+
30+ ##### ` apify upgrade `
31+
32+ ``` sh
33+ DESCRIPTION
34+ Checks that installed Apify CLI version is up to date.
35+
36+ USAGE
37+ $ apify upgrade [-f] [--version < value> ]
38+
39+ FLAGS
40+ -f, --force Whether to skip checking the locally cached latest version of the CLI and fetch it from the internet
41+ instead.
42+ --version=< value> The version of the CLI to upgrade to. If not provided, the latest version will be used.
43+ ```
44+
45+ ##### ` apify telemetry `
46+
47+ ``` sh
48+ DESCRIPTION
49+ Manages telemetry settings. We use this data to improve the CLI and the Apify platform.
50+ Read more: https://docs.apify.com/cli/docs/telemetry
51+
52+ SUBCOMMANDS
53+ telemetry enable Enables telemetry.
54+ telemetry disable Disables telemetry.
55+ ```
56+
57+ ##### ` apify telemetry enable `
58+
59+ ``` sh
60+ DESCRIPTION
61+ Enables telemetry.
62+
63+ USAGE
64+ $ apify enable
65+ ```
66+
67+ ##### ` apify telemetry disable `
68+
69+ ``` sh
70+ DESCRIPTION
71+ Disables telemetry.
72+
73+ USAGE
74+ $ apify disable
75+ ```
1876<!-- general-commands-end -->
1977<!-- prettier-ignore-end -->
2078
@@ -28,7 +86,7 @@ Use these commands to manage your Apify account authentication, access tokens, a
2886
2987``` sh
3088DESCRIPTION
31- Authenticates your Apify account and saves credentials to ' ~/ .apify' .
89+ Authenticates your Apify account and saves credentials to ' /home/runner/ .apify/auth.json ' .
3290 All other commands use these stored credentials.
3391
3492 Run ' apify logout' to remove authentication.
46104
47105``` sh
48106DESCRIPTION
49- Removes authentication by deleting your API token and account information from ' ~/ .apify' .
107+ Removes authentication by deleting your API token and account information from ' /home/runner/ .apify/auth.json ' .
50108 Run ' apify login' to authenticate again.
51109
52110USAGE
@@ -132,18 +190,17 @@ DESCRIPTION
132190 Creates an Actor project from a template in a new directory.
133191
134192USAGE
135- $ apify create [actorName] [--omit-optional-deps] [--skip-dependency-install] [-t < value> ] [--template-archive-url < value > ]
193+ $ apify create [actorName] [--omit-optional-deps] [--skip-dependency-install] [-t < value> ]
136194
137195ARGUMENTS
138196 actorName Name of the Actor and its directory
139197
140198FLAGS
141- --omit-optional-deps Skip installing optional dependencies.
142- --skip-dependency-install Skip installing Actor dependencies.
143- -t, --template=< value> Template for the Actor. If not provided, the command will prompt for it.
144- Visit https://raw.githubusercontent.com/apify/actor-templates/master/templates/manifest.json to find available
145- template names.
146- --template-archive-url=< value> Actor template archive url. Useful for developing new templates.
199+ --omit-optional-deps Skip installing optional dependencies.
200+ --skip-dependency-install Skip installing Actor dependencies.
201+ -t, --template=< value> Template for the Actor. If not provided, the command will prompt for it.
202+ Visit https://raw.githubusercontent.com/apify/actor-templates/master/templates/manifest.json to find available template
203+ names.
147204` ` `
148205
149206# #### `apify init`
@@ -405,7 +462,7 @@ DESCRIPTION
405462 Use --force to override newer remote versions.
406463
407464USAGE
408- $ apify push [actorId] [-b < value> ] [--dir < value> ] [--force] [--no-prompt ] [-v < value> ] [-w < value> ]
465+ $ apify push [actorId] [-b < value> ] [--dir < value> ] [--force] [--open ] [-v < value> ] [-w < value> ]
409466
410467ARGUMENTS
411468 actorId Name or ID of the Actor to push (e.g. " apify/hello-world" or " E2jjCZBezvAZnX8Rb" ). If not provided, the command will create or
@@ -416,8 +473,7 @@ FLAGS
416473 ' .actor/actor.json' file
417474 --dir=< value> Directory where the Actor is located
418475 --force Push an Actor even when the local files are older than the Actor on the platform.
419- --no-prompt Do not prompt for opening the Actor details in a browser. This will also not open the browser
420- automatically.
476+ --open Whether to open the browser automatically to the Actor details page.
421477 -v, --version=< value> Actor version number to which the files should be pushed. By default, it is taken from the
422478 ' .actor/actor.json' file.
423479 -w, --wait-for-finish=< value> Seconds for waiting to build to finish, if no value passed, it waits forever.
@@ -449,7 +505,7 @@ DESCRIPTION
449505 Reads input from local key-value store by default.
450506
451507USAGE
452- $ apify call [actorId] [-b < value> ] [-i < value> | --input-file < value> ] [--json] [-m < value> ] [-o] [-s] [-t < value> ]
508+ $ apify call [actorId] [-b < value> ] [-i < value> | -f < value> ] [--json] [-m < value> ] [-o] [-s] [-t < value> ]
453509
454510ARGUMENTS
455511 actorId Name or ID of the Actor to run (e.g. " my-actor" , " apify/hello-world" or " E2jjCZBezvAZnX8Rb" ). If not provided, the command runs the
@@ -458,8 +514,8 @@ ARGUMENTS
458514FLAGS
459515 -b, --build=< value> Tag or number of the build to run (e.g. " latest" or " 1.2.34" ).
460516 -i, --input=< value> Optional JSON input to be given to the Actor.
461- --input-file=< value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid JSON file.
462- You can also specify ` -` to read from standard input.
517+ -f, --input-file=< value> Optional path to a file with JSON input to be given to the Actor. The file must be a valid JSON
518+ file. You can also specify ` -` to read from standard input.
463519 --json Format the command output as JSON
464520 -m, --memory=< value> Amount of memory allocated for the Actor run, in megabytes.
465521 -o, --output-dataset Prints out the entire default dataset on successful run of the Actor.
0 commit comments