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

package/README.md

@@ -280,7 +280,7 @@ This section contains printouts of `apify help` for all commands.
 * [`apify actor:get-value KEY`](#apify-actorget-value-key)
 * [`apify actor:push-data [ITEM]`](#apify-actorpush-data-item)
 * [`apify actor:set-value KEY [VALUE]`](#apify-actorset-value-key-value)
-* [`apify call [ACTID]`](#apify-call-actid)
+* [`apify call [ACTORID]`](#apify-call-actorid)
 * [`apify create [ACTORNAME]`](#apify-create-actorname)
 * [`apify info`](#apify-info)
 * [`apify init [ACTORNAME]`](#apify-init-actorname)
@@ -296,7 +296,7 @@ This section contains printouts of `apify help` for all commands.
 
 ## `apify actor`
 
-Commands are designed to be used in actor runs. All commands are in PoC state, do not use in production environments.
+Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
 
 ```
 USAGE
@@ -353,7 +353,7 @@ _See code: [src/commands/actor/push-data.js](https://github.com/apify/apify-cli/
 
 ## `apify actor:set-value KEY [VALUE]`
 
-Sets or removes record into the default KeyValueStore associated with the actor run.
+Sets or removes record into the default key-value store associated with the Actor run.
 
 ```
 USAGE
@@ -381,17 +381,17 @@ DESCRIPTION
 
 _See code: [src/commands/actor/set-value.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/actor/set-value.js)_
 
-## `apify call [ACTID]`
+## `apify call [ACTORID]`
 
 Runs a specific actor remotely on the Apify cloud platform.
 
 ```
 USAGE
-  $ apify call [ACTID]
+  $ apify call [ACTORID]
 
 ARGUMENTS
-  ACTID  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.
+  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").
@@ -408,22 +408,22 @@ _See code: [src/commands/call.js](https://github.com/apify/apify-cli/blob/v0.19.
 
 ## `apify create [ACTORNAME]`
 
-Creates a new actor project directory from a selected boilerplate template.
+Creates a new Actor project directory from a selected boilerplate template.
 
 ```
 USAGE
   $ apify create [ACTORNAME]
 
 ARGUMENTS
-  ACTORNAME  Name of the actor and its directory
+  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.
+  -t, --template=template    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.
+  --skip-dependency-install  Skip installing Actor dependencies.
 ```
 
 _See code: [src/commands/create.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/create.js)_
@@ -444,14 +444,14 @@ _See code: [src/commands/info.js](https://github.com/apify/apify-cli/blob/v0.19.
 
 ## `apify init [ACTORNAME]`
 
-Initializes a new actor project in an existing directory.
+Initializes a new Actor project in an existing directory.
 
 ```
 USAGE
   $ apify init [ACTORNAME]
 
 ARGUMENTS
-  ACTORNAME  Name of the actor. If not provided, you will be prompted for it.
+  ACTORNAME  Name of the Actor. If not provided, you will be prompted for it.
 
 OPTIONS
   -y, --yes  Automatic yes to prompts; assume "yes" as answer to all prompts. Note that in some cases, the command may
@@ -557,7 +557,7 @@ _See code: [src/commands/push.js](https://github.com/apify/apify-cli/blob/v0.19.
 
 ## `apify run`
 
-Runs the actor locally in the current directory.
+Runs the Actor locally in the current directory.
 
 ```
 USAGE
@@ -575,8 +575,8 @@ OPTIONS
   --purge-queue            Deletes the local directory containing the default request queue before the run starts.
 
 DESCRIPTION
-  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
+  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.
 
   NOTE: You can override the command's default behavior for Node.js actors by overriding the "start" script in the 
@@ -587,7 +587,7 @@ _See code: [src/commands/run.js](https://github.com/apify/apify-cli/blob/v0.19.3
 
 ## `apify secrets`
 
-Manages secret values for actor environment variables.
+Manages secret values for Actor environment variables.
 
 ```
 USAGE
@@ -657,7 +657,7 @@ ARGUMENTS
   PATH  Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.
 
 DESCRIPTION
-  The input schema for the actor is used from these locations in order of preference.
+  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
   2. Path to JSON file referenced in ".actor/actor.json" under 'input' key

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.19.3","commands":{"call":{"id":"call","description":"Runs a specific actor remotely on the Apify cloud platform.\nThe 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.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"build":{"name":"build","type":"option","char":"b","description":"Tag or number of the build to run (e.g. \"latest\" or \"1.2.34\").","required":false},"timeout":{"name":"timeout","type":"option","char":"t","description":"Timeout for the actor run in seconds. Zero value means there is no timeout.","required":false},"memory":{"name":"memory","type":"option","char":"m","description":"Amount of memory allocated for the actor run, in megabytes.","required":false},"wait-for-finish":{"name":"wait-for-finish","type":"option","char":"w","description":"Seconds for waiting to run to finish, if no value passed, it waits forever.","required":false}},"args":[{"name":"actId","description":"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.","required":false}]},"check-version":{"id":"check-version","description":"Checks that installed Apify CLI version is up to date.","pluginName":"apify-cli","pluginType":"core","hidden":true,"aliases":["cv"],"flags":{"enforce-update":{"name":"enforce-update","type":"boolean","char":"e","description":"[Optional] Enforce version update from NPM","required":false,"allowNo":false}},"args":[]},"create":{"id":"create","description":"Creates a new actor project directory from a selected boilerplate template.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"template":{"name":"template","type":"option","char":"t","description":"Template for the actor. If not provided, the command will prompt for it.\nVisit https://raw.githubusercontent.com/apify/actor-templates/master/templates/manifest.json to find available template names.","required":false},"skip-dependency-install":{"name":"skip-dependency-install","type":"boolean","description":"Skip installing actor dependencies.","required":false,"allowNo":false},"template-archive-url":{"name":"template-archive-url","type":"option","description":"Actor template archive url. Useful for developing new templates.","hidden":true,"required":false}},"args":[{"name":"actorName","description":"Name of the actor and its directory","required":false}]},"edit-input-schema":{"id":"edit-input-schema","description":"Lets you edit your input schema that would be used on the platform in a visual input schema editor.","pluginName":"apify-cli","pluginType":"core","hidden":true,"aliases":["eis"],"flags":{},"args":[{"name":"path","description":"Optional path to your INPUT_SCHEMA.json file. If not provided default platform location for input schema is used.","required":false}]},"info":{"id":"info","description":"Displays information about the currently active Apify account.\nThe information is printed to the console.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"init-wrap-scrapy":{"id":"init-wrap-scrapy","description":"Wraps your existing Scrapy project to work like an Apify Actor.\n\nIt adds the following features:\n- Automatic retry of failed requests\n- Automatic proxy rotation\n- Automatic user agent rotation\n...\n","pluginName":"apify-cli","pluginType":"core","hidden":true,"aliases":[],"flags":{},"args":[{"name":"path","description":"Optional path to your scrapy project. If not provided, the current directory is used.","required":false}]},"init":{"id":"init","description":"Initializes a new actor project in an existing directory.\nThe command only creates the \".actor/actor.json\" file and the \"storage\" directory in the current directory, but will not touch anything else.\n\nWARNING: The directory at \"storage\" will be overwritten if it already exists.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Automatic yes to prompts; assume \"yes\" as answer to all prompts. Note that in some cases, the command may still ask for confirmation.","required":false,"allowNo":false}},"args":[{"name":"actorName","description":"Name of the actor. If not provided, you will be prompted for it.","required":false}]},"login-new":{"id":"login-new","description":"Logs in to your Apify account using your API token.\nThe 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\".","pluginName":"apify-cli","pluginType":"core","hidden":true,"aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"[Optional] Apify API token","required":false}},"args":[]},"login":{"id":"login","description":"Logs in to your Apify account using a provided API token.\nThe 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\".","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"[Optional] Apify API token","required":false}},"args":[]},"logout":{"id":"logout","description":"Logs out of your Apify account.\nThe command deletes the API token and all other account information stored in the ~/.apify directory. To log in again, call \"apify login\".","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"pull":{"id":"pull","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.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"version":{"name":"version","type":"option","char":"v","description":"Actor version number which will be pulled, e.g. 1.2. Default: the highest version","required":false}},"args":[{"name":"actorId","description":"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.","required":false}]},"push":{"id":"push","description":"Uploads the actor to the Apify platform and builds it there.\nThe Actor settings are read from the \".actor/actor.json\" file in the current directory, but they can be overridden using command-line options.\nNOTE: If the source files are smaller than 3 MB then they are uploaded as \n\"Multiple source files\", otherwise they are uploaded as \"Zip file\".\n\nWARNING: If the target Actor already exists in your Apify account, it will be overwritten!","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"version-number":{"name":"version-number","type":"option","description":"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.","required":false},"version":{"name":"version","type":"option","char":"v","description":"Actor version number to which the files should be pushed. By default, it is taken from the \".actor/actor.json\" file.","required":false},"build-tag":{"name":"build-tag","type":"option","char":"b","description":"Build tag to be applied to the successful Actor build. By default, it is taken from the \".actor/actor.json\" file","required":false},"wait-for-finish":{"name":"wait-for-finish","type":"option","char":"w","description":"Seconds for waiting to build to finish, if no value passed, it waits forever.","required":false},"no-prompt":{"name":"no-prompt","type":"boolean","description":"Do not prompt for opening the actor details in a browser. This will also not open the browser automatically.","required":false,"allowNo":false}},"args":[{"name":"actorId","description":"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.","required":false}]},"run":{"id":"run","description":"Runs the actor locally in the current directory.\nIt 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.\n\nNOTE: 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.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"purge":{"name":"purge","type":"boolean","char":"p","description":"Shortcut that combines the --purge-queue, --purge-dataset and --purge-key-value-store options.","required":false,"allowNo":false},"purge-queue":{"name":"purge-queue","type":"boolean","description":"Deletes the local directory containing the default request queue before the run starts.","required":false,"allowNo":false},"purge-dataset":{"name":"purge-dataset","type":"boolean","description":"Deletes the local directory containing the default dataset before the run starts.","required":false,"allowNo":false},"purge-key-value-store":{"name":"purge-key-value-store","type":"boolean","description":"Deletes all records from the default key-value store in the local directory before the run starts, except for the \"INPUT\" key.","required":false,"allowNo":false}},"args":[]},"vis":{"id":"vis","description":"Validates input schema and prints errors found.\nThe input schema for the actor is used from these locations in order of preference.\nThe first one found is validated as it would be the one used on the Apify platform.\n1. Directly embedded object in \".actor/actor.json\" under 'input' key\n2. Path to JSON file referenced in \".actor/actor.json\" under 'input' key\n3. JSON file at .actor/INPUT_SCHEMA.json\n4. JSON file at INPUT_SCHEMA.json\n\nYou can also pass any custom path to your input schema to have it validated instead.\n","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"path","description":"Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.","required":false}]},"actor:get-input":{"id":"actor:get-input","description":"Gets the actor input value from the default key-value store associated with the actor run.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"actor:get-value":{"id":"actor:get-value","description":"Gets a value from the default key-value store associated with the actor run.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"key","description":"Key of the record in key-value store","required":true}]},"actor":{"id":"actor","description":"Commands are designed to be used in actor runs. All commands are in PoC state, do not use in production environments.\n","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"actor:push-data":{"id":"actor:push-data","description":"Stores an object or an array of objects to the default dataset of the actor run.\nIt is possible to pass data using item argument or stdin.\nPassing data using argument:\n$ apify actor:push-data {\"foo\": \"bar\"}\nPassing data using stdin with pipe:\n$ cat ./test.json | apify actor:push-data\n","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"item","description":"JSON string with one object or array of objects containing data to be stored in the default dataset.","required":false}]},"actor:set-value":{"id":"actor:set-value","description":"Sets or removes record into the default KeyValueStore associated with the actor run.\nIt is possible to pass data using argument or stdin.\nPassing data using argument:\n$ apify actor:set-value KEY my-value\nPassing data using stdin with pipe:\n$ cat ./my-text-file.txt | apify actor:set-value KEY --contentType text/plain\n","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"contentType":{"name":"contentType","type":"option","char":"c","description":"Specifies a custom MIME content type of the record. By default \"application/json\" is used.","required":false}},"args":[{"name":"key","description":"Key of the record in key-value store.","required":true},{"name":"value","description":"Record data, which can be one of the following values:\n- If empty, the record in the key-value store is deleted.\n- If no `contentType` flag is specified, value is expected to be any JSON string value.\n- If options.contentType is set, value is taken as is.","required":false}]},"secrets:add":{"id":"secrets:add","description":"Adds a new secret value.\nThe secrets are stored to a file at ~/.apify","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"name","description":"Name of the secret","required":true},{"name":"value","description":"Value of the secret","required":true}]},"secrets":{"id":"secrets","description":"Manages secret values for actor environment variables.\n\nExample:\n$ apify secrets:add mySecret TopSecretValue123\n\nNow the \"mySecret\" value can be used in an environment variable defined in \".actor/actor.json\" file by adding the \"@\" prefix:\n\n{\n  \"actorSpecification\": 1,\n  \"name\": \"my_actor\",\n  \"environmentVariables\": { \"SECRET_ENV_VAR\": \"@mySecret\" },\n  \"version\": \"0.1\n}\n\nWhen the actor is pushed to Apify cloud, the \"SECRET_ENV_VAR\" and its value is stored as a secret environment variable of the actor.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"secrets:rm":{"id":"secrets:rm","description":"Removes the secret.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"name","description":"Name of the secret","required":true}]}}}
+{"version":"0.19.3","commands":{"call":{"id":"call","description":"Runs a specific actor remotely on the Apify cloud platform.\nThe 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.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"build":{"name":"build","type":"option","char":"b","description":"Tag or number of the build to run (e.g. \"latest\" or \"1.2.34\").","required":false},"timeout":{"name":"timeout","type":"option","char":"t","description":"Timeout for the actor run in seconds. Zero value means there is no timeout.","required":false},"memory":{"name":"memory","type":"option","char":"m","description":"Amount of memory allocated for the actor run, in megabytes.","required":false},"wait-for-finish":{"name":"wait-for-finish","type":"option","char":"w","description":"Seconds for waiting to run to finish, if no value passed, it waits forever.","required":false}},"args":[{"name":"actorId","description":"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.","required":false}]},"check-version":{"id":"check-version","description":"Checks that installed Apify CLI version is up to date.","pluginName":"apify-cli","pluginType":"core","hidden":true,"aliases":["cv"],"flags":{"enforce-update":{"name":"enforce-update","type":"boolean","char":"e","description":"[Optional] Enforce version update from NPM","required":false,"allowNo":false}},"args":[]},"create":{"id":"create","description":"Creates a new Actor project directory from a selected boilerplate template.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"template":{"name":"template","type":"option","char":"t","description":"Template for the Actor. If not provided, the command will prompt for it.\nVisit https://raw.githubusercontent.com/apify/actor-templates/master/templates/manifest.json to find available template names.","required":false},"skip-dependency-install":{"name":"skip-dependency-install","type":"boolean","description":"Skip installing Actor dependencies.","required":false,"allowNo":false},"template-archive-url":{"name":"template-archive-url","type":"option","description":"Actor template archive url. Useful for developing new templates.","hidden":true,"required":false}},"args":[{"name":"actorName","description":"Name of the Actor and its directory","required":false}]},"edit-input-schema":{"id":"edit-input-schema","description":"Lets you edit your input schema that would be used on the platform in a visual input schema editor.","pluginName":"apify-cli","pluginType":"core","hidden":true,"aliases":["eis"],"flags":{},"args":[{"name":"path","description":"Optional path to your INPUT_SCHEMA.json file. If not provided default platform location for input schema is used.","required":false}]},"info":{"id":"info","description":"Displays information about the currently active Apify account.\nThe information is printed to the console.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"init-wrap-scrapy":{"id":"init-wrap-scrapy","description":"Wraps your existing Scrapy project to work like an Apify Actor.\n\nIt adds the following features:\n- Automatic retry of failed requests\n- Automatic proxy rotation\n- Automatic user agent rotation\n...\n","pluginName":"apify-cli","pluginType":"core","hidden":true,"aliases":[],"flags":{},"args":[{"name":"path","description":"Optional path to your scrapy project. If not provided, the current directory is used.","required":false}]},"init":{"id":"init","description":"Initializes a new Actor project in an existing directory.\nThe command only creates the \".actor/actor.json\" file and the \"storage\" directory in the current directory, but will not touch anything else.\n\nWARNING: The directory at \"storage\" will be overwritten if it already exists.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Automatic yes to prompts; assume \"yes\" as answer to all prompts. Note that in some cases, the command may still ask for confirmation.","required":false,"allowNo":false}},"args":[{"name":"actorName","description":"Name of the Actor. If not provided, you will be prompted for it.","required":false}]},"login-new":{"id":"login-new","description":"Logs in to your Apify account using your API token.\nThe 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\".","pluginName":"apify-cli","pluginType":"core","hidden":true,"aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"[Optional] Apify API token","required":false}},"args":[]},"login":{"id":"login","description":"Logs in to your Apify account using a provided API token.\nThe 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\".","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"[Optional] Apify API token","required":false}},"args":[]},"logout":{"id":"logout","description":"Logs out of your Apify account.\nThe command deletes the API token and all other account information stored in the ~/.apify directory. To log in again, call \"apify login\".","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"pull":{"id":"pull","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.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"version":{"name":"version","type":"option","char":"v","description":"Actor version number which will be pulled, e.g. 1.2. Default: the highest version","required":false}},"args":[{"name":"actorId","description":"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.","required":false}]},"push":{"id":"push","description":"Uploads the actor to the Apify platform and builds it there.\nThe Actor settings are read from the \".actor/actor.json\" file in the current directory, but they can be overridden using command-line options.\nNOTE: If the source files are smaller than 3 MB then they are uploaded as \n\"Multiple source files\", otherwise they are uploaded as \"Zip file\".\n\nWARNING: If the target Actor already exists in your Apify account, it will be overwritten!","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"version-number":{"name":"version-number","type":"option","description":"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.","required":false},"version":{"name":"version","type":"option","char":"v","description":"Actor version number to which the files should be pushed. By default, it is taken from the \".actor/actor.json\" file.","required":false},"build-tag":{"name":"build-tag","type":"option","char":"b","description":"Build tag to be applied to the successful Actor build. By default, it is taken from the \".actor/actor.json\" file","required":false},"wait-for-finish":{"name":"wait-for-finish","type":"option","char":"w","description":"Seconds for waiting to build to finish, if no value passed, it waits forever.","required":false},"no-prompt":{"name":"no-prompt","type":"boolean","description":"Do not prompt for opening the actor details in a browser. This will also not open the browser automatically.","required":false,"allowNo":false}},"args":[{"name":"actorId","description":"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.","required":false}]},"run":{"id":"run","description":"Runs the Actor locally in the current directory.\nIt 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.\n\nNOTE: 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.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"purge":{"name":"purge","type":"boolean","char":"p","description":"Shortcut that combines the --purge-queue, --purge-dataset and --purge-key-value-store options.","required":false,"allowNo":false},"purge-queue":{"name":"purge-queue","type":"boolean","description":"Deletes the local directory containing the default request queue before the run starts.","required":false,"allowNo":false},"purge-dataset":{"name":"purge-dataset","type":"boolean","description":"Deletes the local directory containing the default dataset before the run starts.","required":false,"allowNo":false},"purge-key-value-store":{"name":"purge-key-value-store","type":"boolean","description":"Deletes all records from the default key-value store in the local directory before the run starts, except for the \"INPUT\" key.","required":false,"allowNo":false}},"args":[]},"vis":{"id":"vis","description":"Validates input schema and prints errors found.\nThe input schema for the Actor is used from these locations in order of preference.\nThe first one found is validated as it would be the one used on the Apify platform.\n1. Directly embedded object in \".actor/actor.json\" under 'input' key\n2. Path to JSON file referenced in \".actor/actor.json\" under 'input' key\n3. JSON file at .actor/INPUT_SCHEMA.json\n4. JSON file at INPUT_SCHEMA.json\n\nYou can also pass any custom path to your input schema to have it validated instead.\n","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"path","description":"Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.","required":false}]},"actor:get-input":{"id":"actor:get-input","description":"Gets the actor input value from the default key-value store associated with the actor run.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"actor:get-value":{"id":"actor:get-value","description":"Gets a value from the default key-value store associated with the actor run.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"key","description":"Key of the record in key-value store","required":true}]},"actor":{"id":"actor","description":"Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.\n","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"actor:push-data":{"id":"actor:push-data","description":"Stores an object or an array of objects to the default dataset of the actor run.\nIt is possible to pass data using item argument or stdin.\nPassing data using argument:\n$ apify actor:push-data {\"foo\": \"bar\"}\nPassing data using stdin with pipe:\n$ cat ./test.json | apify actor:push-data\n","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"item","description":"JSON string with one object or array of objects containing data to be stored in the default dataset.","required":false}]},"actor:set-value":{"id":"actor:set-value","description":"Sets or removes record into the default key-value store associated with the Actor run.\nIt is possible to pass data using argument or stdin.\nPassing data using argument:\n$ apify actor:set-value KEY my-value\nPassing data using stdin with pipe:\n$ cat ./my-text-file.txt | apify actor:set-value KEY --contentType text/plain\n","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{"contentType":{"name":"contentType","type":"option","char":"c","description":"Specifies a custom MIME content type of the record. By default \"application/json\" is used.","required":false}},"args":[{"name":"key","description":"Key of the record in key-value store.","required":true},{"name":"value","description":"Record data, which can be one of the following values:\n- If empty, the record in the key-value store is deleted.\n- If no `contentType` flag is specified, value is expected to be any JSON string value.\n- If options.contentType is set, value is taken as is.","required":false}]},"secrets:add":{"id":"secrets:add","description":"Adds a new secret value.\nThe secrets are stored to a file at ~/.apify","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"name","description":"Name of the secret","required":true},{"name":"value","description":"Value of the secret","required":true}]},"secrets":{"id":"secrets","description":"Manages secret values for Actor environment variables.\n\nExample:\n$ apify secrets:add mySecret TopSecretValue123\n\nNow the \"mySecret\" value can be used in an environment variable defined in \".actor/actor.json\" file by adding the \"@\" prefix:\n\n{\n  \"actorSpecification\": 1,\n  \"name\": \"my_actor\",\n  \"environmentVariables\": { \"SECRET_ENV_VAR\": \"@mySecret\" },\n  \"version\": \"0.1\n}\n\nWhen the actor is pushed to Apify cloud, the \"SECRET_ENV_VAR\" and its value is stored as a secret environment variable of the actor.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"secrets:rm":{"id":"secrets:rm","description":"Removes the secret.","pluginName":"apify-cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"name","description":"Name of the secret","required":true}]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-cli",
-  "version": "0.19.3-beta.2",
+  "version": "0.19.3-beta.3",
   "description": "Apify command-line interface helps you create, develop, build and run Apify actors, and manage the Apify cloud platform.",
   "main": "index.js",
   "scripts": {

package/src/commands/actor/index.js

@@ -8,6 +8,6 @@ class ActorIndexCommand extends Command {
     }
 }
 
-ActorIndexCommand.description = 'Commands are designed to be used in actor runs. All commands are in PoC state, do not use in production environments.\n';
+ActorIndexCommand.description = 'Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.\n';
 
 module.exports = ActorIndexCommand;

package/src/commands/actor/set-value.js

@@ -28,7 +28,7 @@ class SetValueCommand extends ApifyCommand {
     }
 }
 
-SetValueCommand.description = 'Sets or removes record into the default KeyValueStore associated with the actor run.\n'
+SetValueCommand.description = 'Sets or removes record into the default key-value store associated with the Actor run.\n'
     + 'It is possible to pass data using argument or stdin.\n'
     + 'Passing data using argument:\n'
     + '$ apify actor:set-value KEY my-value\n'

package/src/commands/call.js

@@ -21,11 +21,11 @@ class CallCommand extends ApifyCommand {
         const userInfo = await getLocalUserInfo();
         const usernameOrId = userInfo.username || userInfo.id;
 
-        const forceActorId = args.actId;
+        const forceActorId = args.actorId;
         let actorId;
         if (forceActorId) {
             const actor = await apifyClient.actor(forceActorId).get();
-            if (!actor) throw new Error(`Cannot find actor with ID '${forceActorId}' in your account.`);
+            if (!actor) throw new Error(`Cannot find Actor with ID '${forceActorId}' in your account.`);
             actorId = actor.username ? `${actor.username}/${actor.name}` : actor.id;
         } else {
             actorId = `${usernameOrId}/${localConfig.name}`;
@@ -65,7 +65,7 @@ class CallCommand extends ApifyCommand {
             }
         } catch (err) {
             // TODO: Better error message in apify-client-js
-            if (err.type === 'record-not-found') throw new Error(`Actor ${runOpts.actId} not found!`);
+            if (err.type === 'record-not-found') throw new Error(`Actor ${args.actorId} not found!`);
             else throw err;
         }
 
@@ -121,7 +121,7 @@ CallCommand.flags = {
 
 CallCommand.args = [
     {
-        name: 'actId',
+        name: 'actorId',
         required: false,
         description: '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 "${LOCAL_CONFIG_PATH}" file.`,

package/src/commands/create.js

@@ -71,8 +71,8 @@ class CreateCommand extends ApifyCommand {
             fs.mkdirSync(actFolderDir);
         } catch (err) {
             if (err?.code === 'EEXIST') {
-                outputs.error(`Cannot create new actor, directory '${actorName}' already exists. `
-                    + 'You can use "apify init" to create a local actor environment inside an existing directory.');
+                outputs.error(`Cannot create new Actor, directory '${actorName}' already exists. `
+                    + 'You can use "apify init" to create a local Actor environment inside an existing directory.');
                 return;
             }
             throw err;
@@ -172,17 +172,17 @@ class CreateCommand extends ApifyCommand {
     }
 }
 
-CreateCommand.description = 'Creates a new actor project directory from a selected boilerplate template.';
+CreateCommand.description = 'Creates a new Actor project directory from a selected boilerplate template.';
 
 CreateCommand.flags = {
     template: flagsHelper.string({
         char: 't',
-        description: 'Template for the actor. If not provided, the command will prompt for it.\n'
+        description: 'Template for the Actor. If not provided, the command will prompt for it.\n'
             + `Visit ${actorTemplates.manifestUrl} to find available template names.`,
         required: false,
     }),
     'skip-dependency-install': flagsHelper.boolean({
-        description: 'Skip installing actor dependencies.',
+        description: 'Skip installing Actor dependencies.',
         required: false,
     }),
     'template-archive-url': flagsHelper.string({
@@ -196,7 +196,7 @@ CreateCommand.args = [
     {
         name: 'actorName',
         required: false,
-        description: 'Name of the actor and its directory',
+        description: 'Name of the Actor and its directory',
     },
 ];
 

package/src/commands/init.js

@@ -55,11 +55,11 @@ class InitCommand extends ApifyCommand {
         await setLocalEnv(cwd);
         // Create prefilled INPUT.json file from the input schema prefills
         await createPrefilledInputFileFromInputSchema(cwd);
-        outputs.success('The Apify actor has been initialized in the current directory.');
+        outputs.success('The Actor has been initialized in the current directory.');
     }
 }
 
-InitCommand.description = 'Initializes a new actor project in an existing directory.\n'
+InitCommand.description = 'Initializes a new Actor project in an existing directory.\n'
     + `The command only creates the "${LOCAL_CONFIG_PATH}" file and the "${DEFAULT_LOCAL_STORAGE_DIR}" directory in the current directory, `
     + 'but will not touch anything else.\n\n'
     + `WARNING: The directory at "${DEFAULT_LOCAL_STORAGE_DIR}" will be overwritten if it already exists.`;
@@ -68,7 +68,7 @@ InitCommand.args = [
     {
         name: 'actorName',
         required: false,
-        description: 'Name of the actor. If not provided, you will be prompted for it.',
+        description: 'Name of the Actor. If not provided, you will be prompted for it.',
     },
 ];
 

package/src/commands/push.js

@@ -60,7 +60,7 @@ class PushCommand extends ApifyCommand {
         const forceActorId = args.actorId;
         if (forceActorId) {
             actor = await apifyClient.actor(forceActorId).get();
-            if (!actor) throw new Error(`Cannot find actor with ID '${forceActorId}' in your account.`);
+            if (!actor) throw new Error(`Cannot find Actor with ID '${forceActorId}' in your account.`);
             actorId = actor.id;
         } else {
             const usernameOrId = userInfo.username || userInfo.id;

package/src/commands/run.js

@@ -88,7 +88,7 @@ class RunCommand extends ApifyCommand {
         if (!flags.purge) {
             const isStorageEmpty = await checkIfStorageIsEmpty();
             if (!isStorageEmpty) {
-                warning('The storage directory contains a previous state, the actor will continue where it left off. '
+                warning('The storage directory contains a previous state, the Actor will continue where it left off. '
                     + 'To start from the initial state, use --purge parameter to clean the storage directory.');
             }
         }
@@ -172,10 +172,10 @@ class RunCommand extends ApifyCommand {
 
 // TODO: we should describe which env vars are set here:
 
-RunCommand.description = 'Runs the actor locally in the current directory.\n'
+RunCommand.description = 'Runs the Actor locally in the current directory.\n'
     + '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, '
+    + '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 "${DEFAULT_LOCAL_STORAGE_DIR}" directory, `
     + 'rather than on the Apify platform.\n\n'
     + 'NOTE: You can override the command\'s default behavior for Node.js actors by overriding the "start" script in the package.json file. '

package/src/commands/secrets/index.js

@@ -9,7 +9,7 @@ class SecretsIndexCommand extends Command {
     }
 }
 
-SecretsIndexCommand.description = 'Manages secret values for actor environment variables.\n\n'
+SecretsIndexCommand.description = 'Manages secret values for Actor environment variables.\n\n'
     + 'Example:\n'
     + '$ apify secrets:add mySecret TopSecretValue123\n\n'
     + `Now the "mySecret" value can be used in an environment variable defined in "${LOCAL_CONFIG_PATH}" file by adding the "@" prefix:\n\n`

package/src/commands/vis.js

@@ -29,7 +29,7 @@ class ValidateInputSchemaCommand extends ApifyCommand {
 }
 
 ValidateInputSchemaCommand.description = `Validates input schema and prints errors found.
-The input schema for the actor is used from these locations in order of preference.
+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 "${LOCAL_CONFIG_PATH}" under 'input' key
 2. Path to JSON file referenced in "${LOCAL_CONFIG_PATH}" under 'input' key

package/src/lib/create-utils.js

@@ -94,7 +94,7 @@ async function executePrompts(manifest) {
 async function promptActorName() {
     const answer = await inquirer.prompt([{
         name: 'actorName',
-        message: 'Name of your new actor:',
+        message: 'Name of your new Actor:',
         type: 'input',
         validate: (promptText) => {
             try {
@@ -115,7 +115,7 @@ async function promptProgrammingLanguage() {
     const answer = await inquirer.prompt([{
         type: 'list',
         name: 'programmingLanguage',
-        message: 'Choose the programming language of your new actor:',
+        message: 'Choose the programming language of your new Actor:',
         default: PROGRAMMING_LANGUAGES[0],
         choices: PROGRAMMING_LANGUAGES,
         loop: false,
@@ -149,7 +149,7 @@ async function promptTemplateDefinition(manifest, programmingLanguage) {
     const answer = await inquirer.prompt([{
         type: 'list',
         name: 'templateDefinition',
-        message: 'Choose a template for your new actor. Detailed information about the template will be shown in the next step.',
+        message: 'Choose a template for your new Actor. Detailed information about the template will be shown in the next step.',
         default: choices[0],
         choices,
         loop: false,

package/src/lib/utils.js

@@ -210,10 +210,10 @@ const getLocalConfigOrThrow = async () => {
             name: 'isConfirm',
             type: 'confirm',
 
-            message: `The new version of Apify CLI uses the "${LOCAL_CONFIG_PATH}" instead of the "apify.json" file. Since we have found both files in your actor directory, "apify.json" will be renamed to "apify.json.deprecated". Going forward, all commands will use "${LOCAL_CONFIG_PATH}". You can read about the differences between the old and the new config at https://github.com/apify/apify-cli/blob/master/MIGRATIONS.md. Do you want to continue?`,
+            message: `The new version of Apify CLI uses the "${LOCAL_CONFIG_PATH}" instead of the "apify.json" file. Since we have found both files in your Actor directory, "apify.json" will be renamed to "apify.json.deprecated". Going forward, all commands will use "${LOCAL_CONFIG_PATH}". You can read about the differences between the old and the new config at https://github.com/apify/apify-cli/blob/master/MIGRATIONS.md. Do you want to continue?`,
         }]);
         if (!answer.isConfirm) {
-            throw new Error('Command can not run with old "apify.json" file present in your actor directory., Please, either rename or remove it.');
+            throw new Error('Command can not run with old "apify.json" file present in your Actor directory., Please, either rename or remove it.');
         }
         try {
             fs.renameSync(getDeprecatedLocalConfigPath(), `${getDeprecatedLocalConfigPath()}.deprecated`);