apify-cli 0.19.3-beta.3 → 0.19.3-beta.4

package/README.md

@@ -301,6 +301,9 @@ Commands are designed to be used in Actor runs. All commands are in PoC state, d
 ```
 USAGE
   $ apify actor
+
+DESCRIPTION
+  Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
 ```
 
 _See code: [src/commands/actor/index.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/actor/index.js)_
@@ -312,6 +315,9 @@ Gets the actor input value from the default key-value store associated with the
 ```
 USAGE
   $ apify actor:get-input
+
+DESCRIPTION
+  Gets the actor input value from the default key-value store associated with the actor run.
 ```
 
 _See code: [src/commands/actor/get-input.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/actor/get-input.js)_
@@ -326,6 +332,9 @@ USAGE
 
 ARGUMENTS
   KEY  Key of the record in key-value store
+
+DESCRIPTION
+  Gets a value from the default key-value store associated with the actor run.
 ```
 
 _See code: [src/commands/actor/get-value.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/actor/get-value.js)_
@@ -342,6 +351,7 @@ ARGUMENTS
   ITEM  JSON string with one object or array of objects containing data to be stored in the default dataset.
 
 DESCRIPTION
+  Stores an object or an array of objects to the default dataset of the actor run.
   It is possible to pass data using item argument or stdin.
   Passing data using argument:
   $ apify actor:push-data {"foo": "bar"}
@@ -357,21 +367,20 @@ Sets or removes record into the default key-value store associated with the Acto
 
 ```
 USAGE
-  $ apify actor:set-value KEY [VALUE]
+  $ apify actor:set-value KEY [VALUE] [-c <value>]
 
 ARGUMENTS
   KEY    Key of the record in key-value store.
-
   VALUE  Record data, which can be one of the following values:
          - If empty, the record in the key-value store is deleted.
          - If no `contentType` flag is specified, value is expected to be any JSON string value.
          - If options.contentType is set, value is taken as is.
 
-OPTIONS
-  -c, --contentType=contentType  Specifies a custom MIME content type of the record. By default "application/json" is
-                                 used.
+FLAGS
+  -c, --contentType=<value>  Specifies a custom MIME content type of the record. By default "application/json" is used.
 
 DESCRIPTION
+  Sets or removes record into the default key-value store associated with the Actor run.
   It is possible to pass data using argument or stdin.
   Passing data using argument:
   $ apify actor:set-value KEY my-value
@@ -387,20 +396,21 @@ Runs a specific actor remotely on the Apify cloud platform.
 
 ```
 USAGE
-  $ apify call [ACTORID]
+  $ apify call [ACTORID] [-b <value>] [-t <value>] [-m <value>] [-w <value>]
 
 ARGUMENTS
   ACTORID  Name or ID of the actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
            command runs the remote actor specified in the ".actor/actor.json" file.
 
-OPTIONS
-  -b, --build=build                      Tag or number of the build to run (e.g. "latest" or "1.2.34").
-  -m, --memory=memory                    Amount of memory allocated for the actor run, in megabytes.
-  -t, --timeout=timeout                  Timeout for the actor run in seconds. Zero value means there is no timeout.
-  -w, --wait-for-finish=wait-for-finish  Seconds for waiting to run to finish, if no value passed, it waits forever.
+FLAGS
+  -b, --build=<value>            Tag or number of the build to run (e.g. "latest" or "1.2.34").
+  -m, --memory=<value>           Amount of memory allocated for the actor run, in megabytes.
+  -t, --timeout=<value>          Timeout for the actor run in seconds. Zero value means there is no timeout.
+  -w, --wait-for-finish=<value>  Seconds for waiting to run to finish, if no value passed, it waits forever.
 
 DESCRIPTION
-  The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". It 
+  Runs a specific actor remotely on the Apify cloud platform.
+  The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". It
   takes input for the Actor from the default local key-value store by default.
 ```
 
@@ -412,18 +422,20 @@ Creates a new Actor project directory from a selected boilerplate template.
 
 ```
 USAGE
-  $ apify create [ACTORNAME]
+  $ apify create [ACTORNAME] [-t <value>] [--skip-dependency-install]
 
 ARGUMENTS
   ACTORNAME  Name of the Actor and its directory
 
-OPTIONS
-  -t, --template=template    Template for the Actor. If not provided, the command will prompt for it.
+FLAGS
+  -t, --template=<value>     Template for the Actor. If not provided, the command will prompt for it.
                              Visit
                              https://raw.githubusercontent.com/apify/actor-templates/master/templates/manifest.json to
                              find available template names.
-
   --skip-dependency-install  Skip installing Actor dependencies.
+
+DESCRIPTION
+  Creates a new Actor project directory from a selected boilerplate template.
 ```
 
 _See code: [src/commands/create.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/create.js)_
@@ -437,6 +449,7 @@ USAGE
   $ apify info
 
 DESCRIPTION
+  Displays information about the currently active Apify account.
   The information is printed to the console.
 ```
 
@@ -448,17 +461,18 @@ Initializes a new Actor project in an existing directory.
 
 ```
 USAGE
-  $ apify init [ACTORNAME]
+  $ apify init [ACTORNAME] [-y]
 
 ARGUMENTS
   ACTORNAME  Name of the Actor. If not provided, you will be prompted for it.
 
-OPTIONS
+FLAGS
   -y, --yes  Automatic yes to prompts; assume "yes" as answer to all prompts. Note that in some cases, the command may
              still ask for confirmation.
 
 DESCRIPTION
-  The command only creates the ".actor/actor.json" file and the "storage" directory in the current directory, but will 
+  Initializes a new Actor project in an existing directory.
+  The command only creates the ".actor/actor.json" file and the "storage" directory in the current directory, but will
   not touch anything else.
 
   WARNING: The directory at "storage" will be overwritten if it already exists.
@@ -472,13 +486,14 @@ Logs in to your Apify account using a provided API token.
 
 ```
 USAGE
-  $ apify login
+  $ apify login [-t <value>]
 
-OPTIONS
-  -t, --token=token  [Optional] Apify API token
+FLAGS
+  -t, --token=<value>  [Optional] Apify API token
 
 DESCRIPTION
-  The API token and other account information is stored in the ~/.apify directory, from where it is read by all other 
+  Logs in to your Apify account using a provided API token.
+  The API token and other account information is stored in the ~/.apify directory, from where it is read by all other
   "apify" commands. To log out, call "apify logout".
 ```
 
@@ -493,8 +508,9 @@ USAGE
   $ apify logout
 
 DESCRIPTION
+  Logs out of your Apify account.
   The command deletes the API token and all other account information stored in the ~/.apify directory. To log in again,
-   call "apify login".
+  call "apify login".
 ```
 
 _See code: [src/commands/logout.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/logout.js)_
@@ -505,14 +521,18 @@ Pulls an Actor from the Apify platform to the current directory. If it is define
 
 ```
 USAGE
-  $ apify pull [ACTORID]
+  $ apify pull [ACTORID] [-v <value>]
 
 ARGUMENTS
   ACTORID  Name or ID of the actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
            command will update the Actor in the current directory based on its name in ".actor/actor.json" file.
 
-OPTIONS
-  -v, --version=version  Actor version number which will be pulled, e.g. 1.2. Default: the highest version
+FLAGS
+  -v, --version=<value>  Actor version number which will be pulled, e.g. 1.2. Default: the highest version
+
+DESCRIPTION
+  Pulls an Actor from the Apify platform to the current directory. If it is defined as Git repository, it will be
+  cloned. If it is defined as Web IDE, it will fetch the files.
 ```
 
 _See code: [src/commands/pull.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/pull.js)_
@@ -523,31 +543,28 @@ Uploads the actor to the Apify platform and builds it there.
 
 ```
 USAGE
-  $ apify push [ACTORID]
+  $ apify push [ACTORID] [--version-number <value>] [-v <value>] [-b <value>] [-w <value>] [--no-prompt]
 
 ARGUMENTS
   ACTORID  Name or ID of the Actor to push (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). If not provided, the
            command will create or modify the actor with the name specified in ".actor/actor.json" file.
 
-OPTIONS
-  -b, --build-tag=build-tag              Build tag to be applied to the successful Actor build. By default, it is taken
-                                         from the ".actor/actor.json" file
-
-  -v, --version=version                  Actor version number to which the files should be pushed. By default, it is
-                                         taken from the ".actor/actor.json" file.
-
-  -w, --wait-for-finish=wait-for-finish  Seconds for waiting to build to finish, if no value passed, it waits forever.
-
-  --no-prompt                            Do not prompt for opening the actor details in a browser. This will also not
-                                         open the browser automatically.
-
-  --version-number=version-number        DEPRECATED: Use flag version instead. Actor version number to which the files
-                                         should be pushed. By default, it is taken from the ".actor/actor.json" file.
+FLAGS
+  -b, --build-tag=<value>        Build tag to be applied to the successful Actor build. By default, it is taken from the
+                                 ".actor/actor.json" file
+  -v, --version=<value>          Actor version number to which the files should be pushed. By default, it is taken from
+                                 the ".actor/actor.json" file.
+  -w, --wait-for-finish=<value>  Seconds for waiting to build to finish, if no value passed, it waits forever.
+  --no-prompt                    Do not prompt for opening the actor details in a browser. This will also not open the
+                                 browser automatically.
+  --version-number=<value>       DEPRECATED: Use flag version instead. Actor version number to which the files should be
+                                 pushed. By default, it is taken from the ".actor/actor.json" file.
 
 DESCRIPTION
-  The Actor settings are read from the ".actor/actor.json" file in the current directory, but they can be overridden 
+  Uploads the actor to the Apify platform and builds it there.
+  The Actor settings are read from the ".actor/actor.json" file in the current directory, but they can be overridden
   using command-line options.
-  NOTE: If the source files are smaller than 3 MB then they are uploaded as 
+  NOTE: If the source files are smaller than 3 MB then they are uploaded as
   "Multiple source files", otherwise they are uploaded as "Zip file".
 
   WARNING: If the target Actor already exists in your Apify account, it will be overwritten!
@@ -561,25 +578,23 @@ Runs the Actor locally in the current directory.
 
 ```
 USAGE
-  $ apify run
+  $ apify run [-p] [--purge-queue] [--purge-dataset] [--purge-key-value-store]
 
-OPTIONS
+FLAGS
   -p, --purge              Shortcut that combines the --purge-queue, --purge-dataset and --purge-key-value-store
                            options.
-
   --purge-dataset          Deletes the local directory containing the default dataset before the run starts.
-
   --purge-key-value-store  Deletes all records from the default key-value store in the local directory before the run
                            starts, except for the "INPUT" key.
-
   --purge-queue            Deletes the local directory containing the default request queue before the run starts.
 
 DESCRIPTION
+  Runs the Actor locally in the current directory.
   It sets various APIFY_XYZ environment variables in order to provide a working execution environment for the Actor. For
-   example, this causes the Actor input, as well as all other data in key-value stores, datasets or request queues to be
-   stored in the "storage" directory, rather than on the Apify platform.
+  example, this causes the Actor input, as well as all other data in key-value stores, datasets or request queues to be
+  stored in the "storage" directory, rather than on the Apify platform.
 
-  NOTE: You can override the command's default behavior for Node.js actors by overriding the "start" script in the 
+  NOTE: You can override the command's default behavior for Node.js actors by overriding the "start" script in the
   package.json file. You can set up your own main file or environment variables by changing it.
 ```
 
@@ -594,21 +609,23 @@ USAGE
   $ apify secrets
 
 DESCRIPTION
+  Manages secret values for Actor environment variables.
+
   Example:
   $ apify secrets:add mySecret TopSecretValue123
 
-  Now the "mySecret" value can be used in an environment variable defined in ".actor/actor.json" file by adding the "@" 
+  Now the "mySecret" value can be used in an environment variable defined in ".actor/actor.json" file by adding the "@"
   prefix:
 
   {
-    "actorSpecification": 1,
-    "name": "my_actor",
-    "environmentVariables": { "SECRET_ENV_VAR": "@mySecret" },
-    "version": "0.1
+  "actorSpecification": 1,
+  "name": "my_actor",
+  "environmentVariables": { "SECRET_ENV_VAR": "@mySecret" },
+  "version": "0.1
   }
 
   When the actor is pushed to Apify cloud, the "SECRET_ENV_VAR" and its value is stored as a secret environment variable
-   of the actor.
+  of the actor.
 ```
 
 _See code: [src/commands/secrets/index.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/secrets/index.js)_
@@ -626,6 +643,7 @@ ARGUMENTS
   VALUE  Value of the secret
 
 DESCRIPTION
+  Adds a new secret value.
   The secrets are stored to a file at ~/.apify
 ```
 
@@ -641,6 +659,9 @@ USAGE
 
 ARGUMENTS
   NAME  Name of the secret
+
+DESCRIPTION
+  Removes the secret.
 ```
 
 _See code: [src/commands/secrets/rm.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/secrets/rm.js)_
@@ -657,6 +678,7 @@ ARGUMENTS
   PATH  Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.
 
 DESCRIPTION
+  Validates input schema and prints errors found.
   The input schema for the Actor is used from these locations in order of preference.
   The first one found is validated as it would be the one used on the Apify platform.
   1. Directly embedded object in ".actor/actor.json" under 'input' key

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-cli",
-  "version": "0.19.3-beta.3",
+  "version": "0.19.3-beta.4",
   "description": "Apify command-line interface helps you create, develop, build and run Apify actors, and manage the Apify cloud platform.",
   "main": "index.js",
   "scripts": {
@@ -60,6 +60,7 @@
     "@crawlee/memory-storage": "^3.5.8",
     "@oclif/command": "^1.8.36",
     "@oclif/config": "^1.18.17",
+    "@oclif/core": "^2.15.0",
     "@oclif/errors": "^1.3.6",
     "@oclif/plugin-commands": "^2.1.0",
     "@oclif/plugin-help": "^5.1.12",
@@ -109,6 +110,7 @@
       "init": [
         "./src/hooks/init"
       ]
-    }
+    },
+    "helpClass": "./src/lib/apify-oclif-help"
   }
 }

package/src/lib/apify-oclif-help.js

@@ -0,0 +1,23 @@
+const { Help } = require('@oclif/core');
+
+/**
+ * Custom help class that overrides how oclif renders help screens.
+ *
+ * It is registered through package.json.
+ *
+ * Refer to the oclif documentation for more information:
+ * https://oclif.io/docs/help_classes/#custom-help
+ *
+ * Note: The CLI was crashing when printing help with the latest oclif packages. Be careful when upgrading.
+ */
+module.exports = class ApifyOclifHelp extends Help {
+    showRootHelp() {
+        super.showRootHelp();
+
+        this.log(this.section(
+            'TROUBLESHOOTING',
+            this.wrap(
+                'For general support, reach out to us at https://apify.com/contact\n\n'
+                + 'If you believe you are encountering a bug, file it at https://github.com/apify/apify-cli/issues/new')));
+    }
+};