apify-cli 1.0.0-beta.9 → 1.0.0-beta.90

package/README.md

@@ -76,25 +76,25 @@ apify-cli/0.10.0 darwin-x64 node-v16.14.2
 
 The following examples demonstrate the basic usage of Apify CLI.
 
-### Create a new actor from scratch
+### Create a new Actor from scratch
 
 ```bash
 apify create my-hello-world
 ```
 
-First, you will be prompted to select a template with the boilerplate for the actor, to help you get started quickly.
+First, you will be prompted to select a template with the boilerplate for the Actor, to help you get started quickly.
 The command will create a directory called `my-hello-world` that contains a Node.js project
-for the actor and a few configuration files.
+for the Actor and a few configuration files.
 
 > If you decided to skip the installation and go with `npx`, the command will be `npx apify-cli create my-hello-world`.
 
-### Create a new actor from existing project
+### Create a new Actor from existing project
 
 ```bash
 cd ./my/awesome/project
 apify init
 ```
-This command will only set up local actor development environment in an existing directory,
+This command will only set up local Actor development environment in an existing directory,
 i.e. it will create the `.actor/actor.json` file and `apify_storage` directory.
 
 Before you can run your project locally using `apify run`, you have to set up the right start command in `package.json` under scripts.start. For example:
@@ -113,14 +113,14 @@ You can find more information about by running `apify help run`.
 
 If you want to run a Scrapy project on Apify platform, follow the Scrapy integration guide [here](https://docs.apify.com/cli/docs/integrating-scrapy).
 
-### Run the actor locally
+### Run the Actor locally
 
 ```bash
 cd my-hello-world
 apify run
 ```
 
-This command runs the actor on your local machine.
+This command runs the Actor on your local machine.
 Now's your chance to develop the logic - or magic :smirk:
 
 ### Login with your Apify account
@@ -135,21 +135,21 @@ your [Apify API token](https://console.apify.com/account#/integrations).
 Note that the command will store the API token and other sensitive information to `~/.apify`.
 
 
-### Push the actor to the Apify cloud
+### Push the Actor to the Apify cloud
 
 ```bash
 apify push
 ```
 
-This command uploads your project to the Apify cloud and builds an actor from it. On the platform, actor needs to be built before it can be run.
+This command uploads your project to the Apify cloud and builds an Actor from it. On the platform, Actor needs to be built before it can be run.
 
-### Run an actor on the Apify cloud
+### Run an Actor on the Apify cloud
 
 ```bash
 apify call
 ```
 
-Runs the actor corresponding to the current directory on the Apify platform.
+Runs the Actor corresponding to the current directory on the Apify platform.
 
 This command can also be used to run other Actors, for example:
 
@@ -159,8 +159,8 @@ apify call apify/hello-world
 
 ### So what's in this .actor/actor.json file?
 
-This file associates your local development project with an actor on the Apify platform.
-It contains information such as actor name, version, build tag and environment variables.
+This file associates your local development project with an Actor on the Apify platform.
+It contains information such as Actor name, version, build tag and environment variables.
 Make sure you commit this file to the Git repository.
 
 For example, `.actor/actor.json` file can look as follows:
@@ -186,7 +186,7 @@ For example, `.actor/actor.json` file can look as follows:
 ```
 
 **`Dockerfile` field**\
-If you specify the path to your Docker file under the `dockerfile` field, this file will be used for actor builds on the platform. If not specified, the system will look for Docker files at `.actor/Dockerfile` and `Dockerfile` in this order of preference.
+If you specify the path to your Docker file under the `dockerfile` field, this file will be used for Actor builds on the platform. If not specified, the system will look for Docker files at `.actor/Dockerfile` and `Dockerfile` in this order of preference.
 
 **`Readme` field** \
 If you specify the path to your readme file under the `readme` field, the readme at this path will be used on the platform. If not specified, readme at `.actor/README.md` and `README.md` will be used in this order of preference.
@@ -195,17 +195,17 @@ If you specify the path to your readme file under the `readme` field, the readme
 You can embed your [input schema](https://docs.apify.com/actors/development/input-schema#specification-version-1) object directly in `actor.json` under `input` field. Alternatively, you can provide a path to a custom input schema. If not provided, the input schema at `.actor/INPUT_SCHEMA.json` and `INPUT_SCHEMA.json` is used in this order of preference.
 
 **`Storages.dataset` field**\
-You can define the schema of the items in your dataset under the `storages.dataset` field. This can be either an embedded object or a path to a JSON schema file. You can read more about the schema of your actor output [here](https://docs.apify.com/actors/development/output-schema#specification-version-1).
+You can define the schema of the items in your dataset under the `storages.dataset` field. This can be either an embedded object or a path to a JSON schema file. You can read more about the schema of your Actor output [here](https://docs.apify.com/actors/development/output-schema#specification-version-1).
 
 **Note on migration from deprecated config "apify.json"**\
-*Note that previously, actor config was stored in the `apify.json` file that has been deprecated. You can find the (very slight) differences and migration info in [migration guidelines](https://github.com/apify/apify-cli/blob/master/MIGRATIONS.md).*
+*Note that previously, Actor config was stored in the `apify.json` file that has been deprecated. You can find the (very slight) differences and migration info in [migration guidelines](https://github.com/apify/apify-cli/blob/master/MIGRATIONS.md).*
 
 ## Environment variables
 
 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.
+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.
 ```json
 {
     "actorSpecification": 1,
@@ -220,7 +220,7 @@ All keys from `env` will be set as environment variables into Apify platform aft
 ```
 
 ### Set up environment variables in Apify Console
-In [Apify Console](https://console.apify.com/actors) select your actor, you can set up variables into Source tab.
+In [Apify Console](https://console.apify.com/actors) select your Actor, you can set up variables into Source tab.
 After setting up variables in the app, remove the `environmentVariables` from `.actor/actor.json`. Otherwise, variables from `.actor/actor.json` will override variables in the app.
 ```json
 {
@@ -276,13 +276,13 @@ This section contains printouts of `apify help` for all commands.
 
 <!-- commands -->
 * [`apify actor`](#apify-actor)
-* [`apify actor:get-input`](#apify-actorget-input)
-* [`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 actor get-input`](#apify-actor-get-input)
+* [`apify actor get-value KEY`](#apify-actor-get-value-key)
+* [`apify actor push-data [ITEM]`](#apify-actor-push-data-item)
+* [`apify actor set-value KEY [VALUE]`](#apify-actor-set-value-key-value)
 * [`apify call [ACTORID]`](#apify-call-actorid)
 * [`apify create [ACTORNAME]`](#apify-create-actorname)
-* [`apify help [COMMANDS]`](#apify-help-commands)
+* [`apify help [COMMAND]`](#apify-help-command)
 * [`apify info`](#apify-info)
 * [`apify init [ACTORNAME]`](#apify-init-actorname)
 * [`apify login`](#apify-login)
@@ -291,9 +291,9 @@ This section contains printouts of `apify help` for all commands.
 * [`apify push [ACTORID]`](#apify-push-actorid)
 * [`apify run`](#apify-run)
 * [`apify secrets`](#apify-secrets)
-* [`apify secrets:add NAME VALUE`](#apify-secretsadd-name-value)
-* [`apify secrets:rm NAME`](#apify-secretsrm-name)
-* [`apify vis [PATH]`](#apify-vis-path)
+* [`apify secrets add NAME VALUE`](#apify-secrets-add-name-value)
+* [`apify secrets rm NAME`](#apify-secrets-rm-name)
+* [`apify validate-schema [PATH]`](#apify-validate-schema-path)
 
 ## `apify actor`
 
@@ -307,29 +307,29 @@ 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.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/actor/index.ts)_
+_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/actor/index.ts)_
 
-## `apify actor:get-input`
+## `apify actor get-input`
 
 Gets the Actor input value from the default key-value store associated with the Actor run.
 
 ```
 USAGE
-  $ apify actor:get-input
+  $ 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.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/actor/get-input.ts)_
+_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/actor/get-input.ts)_
 
-## `apify actor:get-value KEY`
+## `apify actor get-value KEY`
 
 Gets a value from the default key-value store associated with the Actor run.
 
 ```
 USAGE
-  $ apify actor:get-value KEY
+  $ apify actor get-value KEY
 
 ARGUMENTS
   KEY  Key of the record in key-value store
@@ -338,15 +338,15 @@ DESCRIPTION
   Gets a value from the default key-value store associated with the Actor run.
 ```
 
-_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/actor/get-value.ts)_
+_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/actor/get-value.ts)_
 
-## `apify actor:push-data [ITEM]`
+## `apify actor push-data [ITEM]`
 
 Stores an object or an array of objects to the default dataset of the Actor run.
 
 ```
 USAGE
-  $ apify actor:push-data [ITEM]
+  $ apify actor push-data [ITEM]
 
 ARGUMENTS
   ITEM  JSON string with one object or array of objects containing data to be stored in the default dataset.
@@ -355,20 +355,20 @@ 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"}
+  $ apify actor push-data {"foo": "bar"}
   Passing data using stdin with pipe:
-  $ cat ./test.json | apify actor:push-data
+  $ cat ./test.json | apify actor push-data
 ```
 
-_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/actor/push-data.ts)_
+_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/actor/push-data.ts)_
 
-## `apify actor:set-value KEY [VALUE]`
+## `apify actor set-value KEY [VALUE]`
 
 Sets or removes record into the default KeyValueStore associated with the Actor run.
 
 ```
 USAGE
-  $ apify actor:set-value KEY [VALUE] [-c <value>]
+  $ apify actor set-value KEY [VALUE] [-c <value>]
 
 ARGUMENTS
   KEY    Key of the record in key-value store.
@@ -384,12 +384,12 @@ DESCRIPTION
   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
+  $ apify actor set-value KEY my-value
   Passing data using stdin with pipe:
-  $ cat ./my-text-file.txt | apify actor:set-value KEY --contentType text/plain
+  $ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain
 ```
 
-_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/actor/set-value.ts)_
+_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/actor/set-value.ts)_
 
 ## `apify call [ACTORID]`
 
@@ -400,8 +400,8 @@ 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. "my-actor", "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").
@@ -415,7 +415,7 @@ DESCRIPTION
   takes input for the Actor from the default local key-value store by default.
 ```
 
-_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/call.ts)_
+_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/call.ts)_
 
 ## `apify create [ACTORNAME]`
 
@@ -423,7 +423,7 @@ Creates a new Actor project directory from a selected boilerplate template.
 
 ```
 USAGE
-  $ apify create [ACTORNAME] [-t <value>] [--skip-dependency-install]
+  $ apify create [ACTORNAME] [-t <value>] [--skip-dependency-install] [--omit-optional-deps]
 
 ARGUMENTS
   ACTORNAME  Name of the Actor and its directory
@@ -433,24 +433,25 @@ FLAGS
                                  Visit
                                  https://raw.githubusercontent.com/apify/actor-templates/master/templates/manifest.json
                                  to find available template names.
+      --omit-optional-deps       Skip installing optional dependencies.
       --skip-dependency-install  Skip installing Actor dependencies.
 
 DESCRIPTION
   Creates a new Actor project directory from a selected boilerplate template.
 ```
 
-_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/create.ts)_
+_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/create.ts)_
 
-## `apify help [COMMANDS]`
+## `apify help [COMMAND]`
 
 Display help for apify.
 
 ```
 USAGE
-  $ apify help [COMMANDS] [-n]
+  $ apify help [COMMAND...] [-n]
 
 ARGUMENTS
-  COMMANDS  Command to show help for.
+  COMMAND...  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -459,7 +460,7 @@ DESCRIPTION
   Display help for apify.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.15/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.0/src/commands/help.ts)_
 
 ## `apify info`
 
@@ -474,7 +475,7 @@ DESCRIPTION
   The information is printed to the console.
 ```
 
-_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/info.ts)_
+_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/info.ts)_
 
 ## `apify init [ACTORNAME]`
 
@@ -502,26 +503,28 @@ DESCRIPTION
   WARNING: The directory at "storage" will be overwritten if it already exists.
 ```
 
-_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/init.ts)_
 
 ## `apify login`
 
-Logs in to your Apify account using a provided API token.
+Logs in to your Apify account.
 
 ```
 USAGE
-  $ apify login [-t <value>]
+  $ apify login [-t <value>] [-m console|manual]
 
 FLAGS
-  -t, --token=<value>  [Optional] Apify API token
+  -m, --method=<option>  [Optional] Method of logging in to Apify
+                         <options: console|manual>
+  -t, --token=<value>    [Optional] Apify API token
 
 DESCRIPTION
-  Logs in to your Apify account using a provided API token.
+  Logs in to your Apify account.
   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".
 ```
 
-_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/login.ts)_
 
 ## `apify logout`
 
@@ -537,7 +540,7 @@ DESCRIPTION
   call "apify login".
 ```
 
-_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/logout.ts)_
+_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/logout.ts)_
 
 ## `apify pull [ACTORID]`
 
@@ -559,7 +562,7 @@ DESCRIPTION
   cloned. If it is defined as Web IDE, it will fetch the files.
 ```
 
-_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/pull.ts)_
+_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/pull.ts)_
 
 ## `apify push [ACTORID]`
 
@@ -597,7 +600,7 @@ DESCRIPTION
   overwritten with --force flag.
 ```
 
-_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/push.ts)_
+_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/push.ts)_
 
 ## `apify run`
 
@@ -605,11 +608,15 @@ Runs the Actor locally in the current directory.
 
 ```
 USAGE
-  $ apify run [-p] [--purge-queue] [--purge-dataset] [--purge-key-value-store]
+  $ apify run [-p] [--purge-queue] [--purge-dataset] [--purge-key-value-store] [--entrypoint <value>]
 
 FLAGS
   -p, --purge                  Shortcut that combines the --purge-queue, --purge-dataset and --purge-key-value-store
                                options.
+      --entrypoint=<value>     Optional entrypoint for running with injected environment variables.
+                               For Python, it is the module name, or a path to a file.
+                               For node.js, it is the npm script name, or a path to a JS/MJS file. You can also pass in
+                               a directory name, provided that directory contains an "index.js" file.
       --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.
@@ -625,7 +632,7 @@ DESCRIPTION
   package.json file. You can set up your own main file or environment variables by changing it.
 ```
 
-_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/run.ts)_
+_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/run.ts)_
 
 ## `apify secrets`
 
@@ -639,7 +646,7 @@ DESCRIPTION
   Manages secret values for Actor environment variables.
 
   Example:
-  $ apify secrets:add mySecret TopSecretValue123
+  $ 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 "@"
   prefix:
@@ -655,15 +662,15 @@ DESCRIPTION
   of the Actor.
 ```
 
-_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/secrets/index.ts)_
+_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/secrets/index.ts)_
 
-## `apify secrets:add NAME VALUE`
+## `apify secrets add NAME VALUE`
 
 Adds a new secret value.
 
 ```
 USAGE
-  $ apify secrets:add NAME VALUE
+  $ apify secrets add NAME VALUE
 
 ARGUMENTS
   NAME   Name of the secret
@@ -674,15 +681,15 @@ DESCRIPTION
   The secrets are stored to a file at ~/.apify
 ```
 
-_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/secrets/add.ts)_
+_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/secrets/add.ts)_
 
-## `apify secrets:rm NAME`
+## `apify secrets rm NAME`
 
 Removes the secret.
 
 ```
 USAGE
-  $ apify secrets:rm NAME
+  $ apify secrets rm NAME
 
 ARGUMENTS
   NAME  Name of the secret
@@ -691,15 +698,15 @@ DESCRIPTION
   Removes the secret.
 ```
 
-_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/secrets/rm.ts)_
+_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/secrets/rm.ts)_
 
-## `apify vis [PATH]`
+## `apify validate-schema [PATH]`
 
 Validates input schema and prints errors found.
 
 ```
 USAGE
-  $ apify vis [PATH]
+  $ apify validate-schema [PATH]
 
 ARGUMENTS
   PATH  Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.
@@ -716,5 +723,5 @@ DESCRIPTION
   You can also pass any custom path to your input schema to have it validated instead.
 ```
 
-_See code: [src/commands/vis.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.9/src/commands/vis.ts)_
+_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.90/src/commands/validate-schema.ts)_
 <!-- commandsstop -->

package/bin/dev.js

@@ -1,9 +1,14 @@
-#!/usr/bin/env node_modules/.bin/tsx
-
 import { execute } from '@oclif/core';
+import { satisfies } from 'semver';
 
+import { SUPPORTED_NODEJS_VERSION } from '../src/lib/consts.ts';
 import { error } from '../src/lib/outputs.ts';
 
+if (!satisfies(process.version, SUPPORTED_NODEJS_VERSION)) {
+    error(`Apify CLI requires Node.js version ${SUPPORTED_NODEJS_VERSION}. Your current version is ${process.version}.`);
+    process.exit(1);
+}
+
 try {
     await execute({ development: true, dir: import.meta.url });
 } catch (err) {

package/bin/dev.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+"${DIR}"/../node_modules/.bin/tsx "${DIR}"/dev.js "$@"

package/bin/run.js

@@ -1,9 +1,16 @@
 #!/usr/bin/env node
 
 import { execute } from '@oclif/core';
+import { satisfies } from 'semver';
 
+import { SUPPORTED_NODEJS_VERSION } from '../dist/lib/consts.js';
 import { error } from '../dist/lib/outputs.js';
 
+if (!satisfies(process.version, SUPPORTED_NODEJS_VERSION)) {
+    error(`Apify CLI requires Node.js version ${SUPPORTED_NODEJS_VERSION}. Your current version is ${process.version}.`);
+    process.exit(1);
+}
+
 try {
     await execute({ development: false, dir: import.meta.url });
 } catch (err) {