apify-cli 0.19.3-beta.4 → 1.0.0-beta.0

package/README.md

@@ -4,19 +4,19 @@
 <a href="https://travis-ci.com/apify/apify-cli?branch=master"><img src="https://travis-ci.com/apify/apify-cli.svg?branch=master" loading="lazy" alt="Build Status" style="display:inherit;" /></a>
 
 Apify command-line interface (Apify CLI) helps you create, develop, build and run
-[Apify actors](https://www.apify.com/actors),
+[Apify Actors](https://www.apify.com/actors),
 and manage the Apify cloud platform from any computer.
 
-Apify actors are cloud programs that can perform arbitrary web scraping, automation or data processing job.
+Apify Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job.
 They accept input, perform their job and generate output.
-While you can develop actors in an online IDE directly in the [Apify web application](https://console.apify.com/),
-for complex projects it is more convenient to develop actors locally on your computer
+While you can develop Actors in an online IDE directly in the [Apify web application](https://console.apify.com/),
+for complex projects it is more convenient to develop Actors locally on your computer
 using <a href="https://github.com/apify/apify-sdk-js">Apify SDK</a>
-and only push the actors to the Apify cloud during deployment.
+and only push the Actors to the Apify cloud during deployment.
 This is where the Apify CLI comes in.
 
-Note that actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile`
-you can build your actors in any programming language.
+Note that Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile`
+you can build your Actors in any programming language.
 However, we recommend using JavaScript / Node.js, for which we provide most libraries and support.
 
 
@@ -151,7 +151,7 @@ apify call
 
 Runs the actor corresponding to the current directory on the Apify platform.
 
-This command can also be used to run other actors, for example:
+This command can also be used to run other Actors, for example:
 
 ```bash
 apify call apify/hello-world
@@ -202,7 +202,7 @@ You can define the schema of the items in your dataset under the `storages.datas
 
 ## Environment variables
 
-There are two options how you can set up environment variables for actors.
+There are two options how you can set up environment variables for Actors.
 
 ### Set up environment variables in .actor/actor.json
 All keys from `env` will be set as environment variables into Apify platform after you push actor to Apify. Current values on Apify will be overridden.
@@ -282,6 +282,7 @@ This section contains printouts of `apify help` for all commands.
 * [`apify actor:set-value KEY [VALUE]`](#apify-actorset-value-key-value)
 * [`apify call [ACTORID]`](#apify-call-actorid)
 * [`apify create [ACTORNAME]`](#apify-create-actorname)
+* [`apify help [COMMANDS]`](#apify-help-commands)
 * [`apify info`](#apify-info)
 * [`apify init [ACTORNAME]`](#apify-init-actorname)
 * [`apify login`](#apify-login)
@@ -306,25 +307,25 @@ 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)_
+_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/actor/index.ts)_
 
 ## `apify actor:get-input`
 
-Gets the actor input value from the default key-value store associated with the actor run.
+Gets the Actor input value from the default key-value store associated with the Actor run.
 
 ```
 USAGE
   $ apify actor:get-input
 
 DESCRIPTION
-  Gets the actor input value from the default key-value store associated with the actor run.
+  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)_
+_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/actor/get-input.ts)_
 
 ## `apify actor:get-value KEY`
 
-Gets a value from the default key-value store associated with the actor run.
+Gets a value from the default key-value store associated with the Actor run.
 
 ```
 USAGE
@@ -334,14 +335,14 @@ 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.
+  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)_
+_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/actor/get-value.ts)_
 
 ## `apify actor:push-data [ITEM]`
 
-Stores an object or an array of objects to the default dataset of the actor run.
+Stores an object or an array of objects to the default dataset of the Actor run.
 
 ```
 USAGE
@@ -351,7 +352,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.
+  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"}
@@ -359,11 +360,11 @@ DESCRIPTION
   $ cat ./test.json | apify actor:push-data
 ```
 
-_See code: [src/commands/actor/push-data.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/actor/push-data.js)_
+_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/actor/push-data.ts)_
 
 ## `apify actor:set-value KEY [VALUE]`
 
-Sets or removes record into the default key-value store associated with the Actor run.
+Sets or removes record into the default KeyValueStore associated with the Actor run.
 
 ```
 USAGE
@@ -380,7 +381,7 @@ 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.
+  Sets or removes record into the default KeyValueStore 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
@@ -388,33 +389,33 @@ DESCRIPTION
   $ cat ./my-text-file.txt | apify actor:set-value KEY --contentType text/plain
 ```
 
-_See code: [src/commands/actor/set-value.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/actor/set-value.js)_
+_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/actor/set-value.ts)_
 
 ## `apify call [ACTORID]`
 
-Runs a specific actor remotely on the Apify cloud platform.
+Runs a specific Actor remotely on the Apify cloud platform.
 
 ```
 USAGE
   $ 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.
+  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.
 
 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.
+  -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
-  Runs a specific actor remotely on the Apify cloud platform.
+  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.
 ```
 
-_See code: [src/commands/call.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/call.js)_
+_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/call.ts)_
 
 ## `apify create [ACTORNAME]`
 
@@ -428,17 +429,37 @@ ARGUMENTS
   ACTORNAME  Name of the Actor and its directory
 
 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.
+  -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)_
+_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/create.ts)_
+
+## `apify help [COMMANDS]`
+
+Display help for apify.
+
+```
+USAGE
+  $ apify help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for apify.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.14/src/commands/help.ts)_
 
 ## `apify info`
 
@@ -453,7 +474,7 @@ DESCRIPTION
   The information is printed to the console.
 ```
 
-_See code: [src/commands/info.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/info.js)_
+_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/info.ts)_
 
 ## `apify init [ACTORNAME]`
 
@@ -472,13 +493,16 @@ FLAGS
 
 DESCRIPTION
   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.
+  If the directory contains a Scrapy project in Python, the command automatically creates wrappers so that you can run
+  your scrapers without changes.
+
+  The command creates the ".actor/actor.json" file and the "storage" directory in the current directory, but does not
+  touch any other existing files or directories.
 
   WARNING: The directory at "storage" will be overwritten if it already exists.
 ```
 
-_See code: [src/commands/init.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/init.js)_
+_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/init.ts)_
 
 ## `apify login`
 
@@ -497,7 +521,7 @@ DESCRIPTION
   "apify" commands. To log out, call "apify logout".
 ```
 
-_See code: [src/commands/login.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/login.js)_
+_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/login.ts)_
 
 ## `apify logout`
 
@@ -513,7 +537,7 @@ DESCRIPTION
   call "apify login".
 ```
 
-_See code: [src/commands/logout.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/logout.js)_
+_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/logout.ts)_
 
 ## `apify pull [ACTORID]`
 
@@ -524,7 +548,7 @@ USAGE
   $ 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
+  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.
 
 FLAGS
@@ -535,11 +559,11 @@ DESCRIPTION
   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)_
+_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/pull.ts)_
 
 ## `apify push [ACTORID]`
 
-Uploads the actor to the Apify platform and builds it there.
+Uploads the Actor to the Apify platform and builds it there.
 
 ```
 USAGE
@@ -547,7 +571,7 @@ USAGE
 
 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.
+           command will create or modify the Actor with the name specified in ".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
@@ -555,13 +579,13 @@ FLAGS
   -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
+      --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
+      --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
-  Uploads the actor to the Apify platform and builds it there.
+  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
@@ -570,7 +594,7 @@ DESCRIPTION
   WARNING: If the target Actor already exists in your Apify account, it will be overwritten!
 ```
 
-_See code: [src/commands/push.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/push.js)_
+_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/push.ts)_
 
 ## `apify run`
 
@@ -581,12 +605,12 @@ USAGE
   $ apify run [-p] [--purge-queue] [--purge-dataset] [--purge-key-value-store]
 
 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.
+  -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.
@@ -594,11 +618,11 @@ DESCRIPTION
   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.
 ```
 
-_See code: [src/commands/run.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/run.js)_
+_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/run.ts)_
 
 ## `apify secrets`
 
@@ -624,11 +648,11 @@ DESCRIPTION
   "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.
+  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.
 ```
 
-_See code: [src/commands/secrets/index.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/secrets/index.js)_
+_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/secrets/index.ts)_
 
 ## `apify secrets:add NAME VALUE`
 
@@ -647,7 +671,7 @@ DESCRIPTION
   The secrets are stored to a file at ~/.apify
 ```
 
-_See code: [src/commands/secrets/add.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/secrets/add.js)_
+_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/secrets/add.ts)_
 
 ## `apify secrets:rm NAME`
 
@@ -664,7 +688,7 @@ 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)_
+_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/secrets/rm.ts)_
 
 ## `apify vis [PATH]`
 
@@ -689,5 +713,5 @@ DESCRIPTION
   You can also pass any custom path to your input schema to have it validated instead.
 ```
 
-_See code: [src/commands/vis.js](https://github.com/apify/apify-cli/blob/v0.19.3/src/commands/vis.js)_
+_See code: [src/commands/vis.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.0/src/commands/vis.ts)_
 <!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node_modules/.bin/tsx
+
+import { execute } from '@oclif/core';
+
+import { error } from '../src/lib/outputs.ts';
+
+try {
+    await execute({ development: true, dir: import.meta.url });
+} catch (err) {
+    const exitCode = (err.oclif && err.oclif.exit !== undefined) ? err.oclif.exit : 1;
+    if (exitCode !== 0) {
+        error(err.message);
+        if (process.env.DEBUG) console.error(err);
+        process.exit(exitCode);
+    }
+}

package/bin/run.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+
+import { execute } from '@oclif/core';
+
+import { error } from '../dist/lib/outputs.js';
+
+try {
+    await execute({ development: false, dir: import.meta.url });
+} catch (err) {
+    const exitCode = (err.oclif && err.oclif.exit !== undefined) ? err.oclif.exit : 1;
+    if (exitCode !== 0) {
+        error(err.message);
+        if (process.env.DEBUG) console.error(err);
+        process.exit(exitCode);
+    }
+}