apify-cli 0.10.0-beta.2 → 0.11.0-beta.0

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.10.0","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 \"apify.json\" file.","required":false}]},"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.Visit https://raw.githubusercontent.com/apify/actor-templates/master/templates/manifest.json to find available template names.","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 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 ./INPUT_SCHEMA.json 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":{"id":"init","description":"Initializes a new actor project in an existing directory.\nThe command only creates the \"apify.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":{},"args":[{"name":"actorName","description":"Name of the actor. If not provided, you will be prompted for it.","required":false}]},"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":[]},"push":{"id":"push","description":"Uploads the actor to the Apify platform and builds it there.\nThe actor settings are read from the \"apify.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 \"apify.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 \"apify.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 \"apify.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}},"args":[{"name":"actorId","description":"ID of an existing actor on the Apify platform where the files will be pushed. If not provided, the command will create or modify the actor with the name specified in \"apify.json\" file.","required":false}]},"run":{"id":"run","description":"Runs the actor locally in the current directory by executing \"npm start\".\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 default behaviour of command overriding npm start script value in a 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.json file and prints errors found.","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 \"apify.json\" file by adding the \"@\" prefix:\n\n{\n  \"name\": \"my_actor\",\n  \"env\": { \"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.11.0","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}]},"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.Visit https://raw.githubusercontent.com/apify/actor-templates/master/templates/manifest.json to find available template names.","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":{"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":{},"args":[{"name":"actorName","description":"Name of the actor. If not provided, you will be prompted for it.","required":false}]},"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":[]},"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}},"args":[{"name":"actorId","description":"ID of an existing actor on the Apify platform where the files will be pushed. 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 by executing \"npm start\".\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 by overriding the npm start script value in a 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}]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-cli",
-  "version": "0.10.0-beta.2",
+  "version": "0.11.0-beta.0",
   "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/call.js

@@ -5,6 +5,7 @@ const { ApifyCommand } = require('../lib/apify_command');
 const { getLocalConfig, getLoggedClientOrThrow,
     getLocalUserInfo, getLocalInput, outputJobLog } = require('../lib/utils');
 const outputs = require('../lib/outputs');
+const { LOCAL_CONFIG_PATH } = require('../lib/consts');
 
 // TODO: Show full error messages and HTTP codes, this is not great:
 // jan:testx$ apify call help
@@ -90,7 +91,7 @@ class CallCommand extends ApifyCommand {
 }
 
 CallCommand.description = 'Runs a specific actor remotely on the Apify cloud platform.\n'
-    + 'The actor is run under your current Apify account, therefore you need to be logged in by calling "apify login". '
+    + '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.';
 
 CallCommand.flags = {
@@ -123,7 +124,7 @@ CallCommand.args = [
         name: 'actId',
         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 "apify.json" file.',
+            + `If not provided, the command runs the remote actor specified in the "${LOCAL_CONFIG_PATH}" file.`,
     },
 ];
 

package/src/commands/create.js

@@ -9,7 +9,7 @@ const { ApifyCommand } = require('../lib/apify_command');
 const execWithLog = require('../lib/exec');
 const outputs = require('../lib/outputs');
 const { updateLocalJson } = require('../lib/files');
-const { setLocalConfig, setLocalEnv, getNpmCmd, validateActorName } = require('../lib/utils');
+const { setLocalConfig, setLocalEnv, getNpmCmd, validateActorName, getLocalConfig } = require('../lib/utils');
 const { EMPTY_LOCAL_CONFIG } = require('../lib/consts');
 
 class CreateCommand extends ApifyCommand {
@@ -78,7 +78,9 @@ class CreateCommand extends ApifyCommand {
         const unzip = unzipper.Extract({ path: actFolderDir });
         await zipStream.pipe(unzip).promise();
 
-        await setLocalConfig(Object.assign(EMPTY_LOCAL_CONFIG, { name: actorName, template: templateName }), actFolderDir);
+        // There may be .actor/actor.json file in used template - let's try to load it and change the name prop value to actorName
+        const localConfig = await getLocalConfig();
+        await setLocalConfig(Object.assign(localConfig || EMPTY_LOCAL_CONFIG, { name: actorName }), actFolderDir);
         await setLocalEnv(actFolderDir);
         await updateLocalJson(path.join(actFolderDir, 'package.json'), { name: actorName });
 

package/src/commands/edit-input-schema.js

@@ -1,4 +1,5 @@
 const fs = require('fs');
+const path = require('path');
 
 const cors = require('cors');
 const detectIndent = require('detect-indent');
@@ -9,22 +10,30 @@ const { cryptoRandomObjectId } = require('@apify/utilities');
 
 const { ApifyCommand } = require('../lib/apify_command');
 const outputs = require('../lib/outputs');
+const { readInputSchema } = require('../lib/input_schema');
+const { LOCAL_CONFIG_PATH } = require('../lib/consts');
 
 const INPUT_SCHEMA_EDITOR_BASE_URL = 'https://apify.github.io/input-schema-editor-react/';
 const INPUT_SCHEMA_EDITOR_ORIGIN = new URL(INPUT_SCHEMA_EDITOR_BASE_URL).origin;
 
-const DEFAULT_INPUT_SCHEMA_PATH = './INPUT_SCHEMA.json';
-
 // Not really checked right now, but it might come useful if we ever need to do some breaking changes
 const API_VERSION = 'v1';
 
 class EditInputSchemaCommand extends ApifyCommand {
     async run() {
         const { args } = this.parse(EditInputSchemaCommand);
-        const { path = DEFAULT_INPUT_SCHEMA_PATH } = args;
+
+        // This call fails if no input schema is found on any of the default locations
+        const { inputSchema: existingSchema, inputSchemaPath } = await readInputSchema(args.path);
+
+        if (existingSchema && !inputSchemaPath) {
+            // If path is not returned, it means the input schema must be directly embedded as object in actor.json
+            // TODO - allow editing input schema embedded in actor.json
+            throw new Error(`Editing an input schema directly embedded in "${LOCAL_CONFIG_PATH}" is not yet supported.`);
+        }
 
         outputs.warning('This command is still experimental and might break at any time. Use at your own risk.\n');
-        outputs.info(`Editing input schema at "${path}"...`);
+        outputs.info(`Editing input schema at "${inputSchemaPath}"...`);
 
         let server;
         const app = express();
@@ -76,14 +85,18 @@ class EditInputSchemaCommand extends ApifyCommand {
         apiRouter.get('/input-schema', (req, res) => {
             let inputSchemaStr;
             try {
-                inputSchemaStr = fs.readFileSync(path, { encoding: 'utf-8', flag: 'a+' });
-                if (inputSchemaStr.length > 2) {
+                inputSchemaStr = fs.existsSync(inputSchemaPath) ? fs.readFileSync(inputSchemaPath, { encoding: 'utf-8' }) : '{}\n';
+                if (inputSchemaStr.length > 3) {
                     jsonIndentation = detectIndent(inputSchemaStr).indent || jsonIndentation;
                 }
                 if (inputSchemaStr) {
                     appendFinalNewline = inputSchemaStr[inputSchemaStr.length - 1] === '\n';
                 }
-                outputs.info('Input schema loaded from disk.');
+                if (fs.existsSync(inputSchemaPath)) {
+                    outputs.info(`Input schema loaded from "${inputSchemaPath}"`);
+                } else {
+                    outputs.info(`Empty input schema initialized.`);
+                }
             } catch (err) {
                 const errorMessage = `Reading input schema from disk failed with: ${err.message}`;
                 outputs.error(errorMessage);
@@ -113,7 +126,13 @@ class EditInputSchemaCommand extends ApifyCommand {
                 const inputSchemaObj = req.body;
                 let inputSchemaStr = JSON.stringify(inputSchemaObj, null, jsonIndentation);
                 if (appendFinalNewline) inputSchemaStr += '\n';
-                fs.writeFileSync(path, inputSchemaStr, { encoding: 'utf-8', flag: 'w+' });
+
+                const inputSchemaDir = path.dirname(inputSchemaPath);
+                if (!fs.existsSync(inputSchemaDir)) {
+                    fs.mkdirSync(inputSchemaDir, { recursive: true });
+                }
+
+                fs.writeFileSync(inputSchemaPath, inputSchemaStr, { encoding: 'utf-8', flag: 'w+' });
                 res.end();
                 outputs.info('Input schema saved to disk.');
             } catch (err) {
@@ -145,13 +164,13 @@ class EditInputSchemaCommand extends ApifyCommand {
     }
 }
 
-EditInputSchemaCommand.description = 'Lets you edit your input schema in a visual input schema editor.';
+EditInputSchemaCommand.description = 'Lets you edit your input schema that would be used on the platform in a visual input schema editor.';
 
 EditInputSchemaCommand.args = [
     {
         name: 'path',
         required: false,
-        description: 'Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.',
+        description: 'Optional path to your INPUT_SCHEMA.json file. If not provided default platform location for input schema is used.',
     },
 ];
 

package/src/commands/init.js

@@ -2,8 +2,8 @@ const inquirer = require('inquirer');
 const path = require('path');
 const { ApifyCommand } = require('../lib/apify_command');
 const outputs = require('../lib/outputs');
-const { setLocalConfig, setLocalEnv, getLocalConfig } = require('../lib/utils');
-const { EMPTY_LOCAL_CONFIG, DEFAULT_LOCAL_STORAGE_DIR } = require('../lib/consts');
+const { setLocalConfig, setLocalEnv, getLocalConfig, getLocalConfigOrThrow } = require('../lib/utils');
+const { EMPTY_LOCAL_CONFIG, DEFAULT_LOCAL_STORAGE_DIR, LOCAL_CONFIG_PATH } = require('../lib/consts');
 
 class InitCommand extends ApifyCommand {
     async run() {
@@ -12,13 +12,15 @@ class InitCommand extends ApifyCommand {
         const cwd = process.cwd();
 
         if (getLocalConfig()) {
-            outputs.warning('Skipping creation of apify.json, the file already exists in the current directory.');
+            outputs.warning(`Skipping creation of "${LOCAL_CONFIG_PATH}", the file already exists in the current directory.`);
         } else {
             if (!actorName) {
                 const answer = await inquirer.prompt([{ name: 'actName', message: 'Actor name:', default: path.basename(cwd) }]);
                 ({ actName: actorName } = answer);
             }
-            await setLocalConfig(Object.assign(EMPTY_LOCAL_CONFIG, { name: actorName }), cwd);
+            // Migrate apify.json to .actor/actor.json
+            const localConfig = { ...EMPTY_LOCAL_CONFIG, ...await getLocalConfigOrThrow() };
+            await setLocalConfig(Object.assign(localConfig, { name: actorName }), cwd);
         }
         await setLocalEnv(cwd);
         outputs.success('The Apify actor has been initialized in the current directory.');
@@ -26,7 +28,7 @@ class InitCommand extends ApifyCommand {
 }
 
 InitCommand.description = 'Initializes a new actor project in an existing directory.\n'
-    + `The command only creates the "apify.json" file and the "${DEFAULT_LOCAL_STORAGE_DIR}" directory in the current directory, `
+    + `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.`;
 

package/src/commands/push.js

@@ -8,7 +8,7 @@ const { createActZip, getLoggedClientOrThrow,
     outputJobLog, getLocalUserInfo, getActorLocalFilePaths,
     createSourceFiles, getLocalConfigOrThrow } = require('../lib/utils');
 const { sumFilesSizeInBytes } = require('../lib/files');
-const { UPLOADS_STORE_NAME } = require('../lib/consts');
+const { UPLOADS_STORE_NAME, LOCAL_CONFIG_PATH } = require('../lib/consts');
 const { transformEnvToEnvVars } = require('../lib/secrets');
 const outputs = require('../lib/outputs');
 
@@ -94,15 +94,17 @@ class PushCommand extends ApifyCommand {
                 contentType: 'application/zip',
             });
             fs.unlinkSync(TEMP_ZIP_FILE_NAME);
-            tarballUrl = `https://api.apify.com/v2/key-value-stores/${store.id}/records/${key}?disableRedirect=true`;
+            tarballUrl = `${apifyClient.baseUrl}/key-value-stores/${store.id}/records/${key}?disableRedirect=true`;
             sourceType = ACT_SOURCE_TYPES.TARBALL;
         }
 
         // Update actor version
         const actorCurrentVersion = await actorClient.version(version).get();
+        const envVars = localConfig.environmentVariables
+            ? transformEnvToEnvVars(localConfig.environmentVariables)
+            : undefined;
         if (actorCurrentVersion) {
-            const actorVersionModifier = { tarballUrl, sourceFiles, buildTag, sourceType };
-            if (localConfig.env) actorVersionModifier.envVars = transformEnvToEnvVars(localConfig.env);
+            const actorVersionModifier = { tarballUrl, sourceFiles, buildTag, sourceType, envVars };
             await actorClient.version(version).update(actorVersionModifier);
             outputs.run(`Updated version ${version} for ${actor.name} actor.`);
         } else {
@@ -112,8 +114,8 @@ class PushCommand extends ApifyCommand {
                 sourceFiles,
                 buildTag,
                 sourceType,
+                envVars,
             };
-            if (localConfig.env) actorNewVersion.envVars = transformEnvToEnvVars(localConfig.env);
             await actorClient.versions().create({
                 versionNumber: version,
                 ...actorNewVersion,
@@ -150,7 +152,7 @@ class PushCommand extends ApifyCommand {
 }
 
 PushCommand.description = 'Uploads the actor to the Apify platform and builds it there.\n'
-    + 'The actor settings are read from the "apify.json" file in the current directory, but they can be overridden using command-line options.\n'
+    + `The actor settings are read from the "${LOCAL_CONFIG_PATH}" file in the current directory, but they can be overridden using command-line options.\n`
     + `NOTE: If the source files are smaller than ${MAX_MULTIFILE_BYTES / (1024 ** 2)} MB then they are uploaded as \n`
     + '"Multiple source files", otherwise they are uploaded as "Zip file".\n\n'
     + 'WARNING: If the target actor already exists in your Apify account, it will be overwritten!';
@@ -158,17 +160,17 @@ PushCommand.description = 'Uploads the actor to the Apify platform and builds it
 PushCommand.flags = {
     'version-number': flagsHelper.string({
         description: 'DEPRECATED: Use flag version instead. Actor version number to which the files should be pushed. '
-            + 'By default, it is taken from the "apify.json" file.',
+            + `By default, it is taken from the "${LOCAL_CONFIG_PATH}" file.`,
         required: false,
     }),
     version: flagsHelper.string({
         char: 'v',
-        description: 'Actor version number to which the files should be pushed. By default, it is taken from the "apify.json" file.',
+        description: `Actor version number to which the files should be pushed. By default, it is taken from the "${LOCAL_CONFIG_PATH}" file.`,
         required: false,
     }),
     'build-tag': flagsHelper.string({
         char: 'b',
-        description: 'Build tag to be applied to the successful actor build. By default, it is taken from the "apify.json" file',
+        description: `Build tag to be applied to the successful actor build. By default, it is taken from the "${LOCAL_CONFIG_PATH}" file`,
         required: false,
     }),
     'wait-for-finish': flagsHelper.string({
@@ -183,7 +185,7 @@ PushCommand.args = [
         name: 'actorId',
         required: false,
         description: 'ID of an existing actor on the Apify platform where the files will be pushed. '
-        + 'If not provided, the command will create or modify the actor with the name specified in "apify.json" file.',
+        + `If not provided, the command will create or modify the actor with the name specified in "${LOCAL_CONFIG_PATH}" file.`,
     },
 ];
 

package/src/commands/run.js

@@ -71,8 +71,8 @@ class RunCommand extends ApifyCommand {
         if (proxy && proxy.password) localEnvVars[ENV_VARS.PROXY_PASSWORD] = proxy.password;
         if (userId) localEnvVars[ENV_VARS.USER_ID] = userId;
         if (token) localEnvVars[ENV_VARS.TOKEN] = token;
-        if (localConfig.env) {
-            const updatedEnv = replaceSecretsValue(localConfig.env);
+        if (localConfig.environmentVariables) {
+            const updatedEnv = replaceSecretsValue(localConfig.environmentVariables);
             Object.assign(localEnvVars, updatedEnv);
         }
         // NOTE: User can overwrite env vars
@@ -106,7 +106,7 @@ RunCommand.description = 'Runs the actor locally in the current directory by exe
     + '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 default behaviour of command overriding npm start script value in a package.json file. '
+    + 'NOTE: You can override the command\'s default behavior by overriding the npm start script value in a package.json file. '
     + 'You can set up your own main file or environment variables by changing it.';
 
 RunCommand.flags = {

package/src/commands/secrets/index.js

@@ -1,4 +1,5 @@
 const { Command } = require('@oclif/command');
+const { LOCAL_CONFIG_PATH } = require('../../lib/consts');
 const { showHelpForCommand } = require('../../lib/utils');
 
 class SecretsIndexCommand extends Command {
@@ -10,10 +11,11 @@ class SecretsIndexCommand extends Command {
 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 "apify.json" file by adding the "@" prefix:\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`
     + '{\n'
+    + '  "actorSpecification": 1,\n'
     + '  "name": "my_actor",\n'
-    + '  "env": { "SECRET_ENV_VAR": "@mySecret" },\n'
+    + '  "environmentVariables": { "SECRET_ENV_VAR": "@mySecret" },\n'
     + '  "version": "0.1\n'
     + '}\n\n'
     + '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.';

package/src/commands/vis.js

@@ -1,32 +1,42 @@
 const { validateInputSchema } = require('@apify/input_schema');
 const Ajv = require('ajv');
-const fs = require('fs');
 const { ApifyCommand } = require('../lib/apify_command');
+const { LOCAL_CONFIG_PATH } = require('../lib/consts');
+const { readInputSchema } = require('../lib/input_schema');
 const outputs = require('../lib/outputs');
 
-const DEFAULT_INPUT_SCHEMA_PATH = './INPUT_SCHEMA.json';
-
 class ValidateInputSchemaCommand extends ApifyCommand {
     async run() {
         const { args } = this.parse(ValidateInputSchemaCommand);
-        const { path = DEFAULT_INPUT_SCHEMA_PATH } = args;
-        const validator = new Ajv({ strict: false });
 
-        let inputSchemaObj;
+        const { inputSchema, inputSchemaPath } = await readInputSchema(args.path);
+
+        if (!inputSchema) {
+            throw new Error(`Input schema has not been found at ${inputSchemaPath}.`);
+        }
 
-        try {
-            const inputSchemaStr = fs.readFileSync(path).toString();
-            inputSchemaObj = JSON.parse(inputSchemaStr);
-        } catch (err) {
-            throw new Error(`Input schema is not a valid JSON (${err})`);
+        if (inputSchemaPath) {
+            outputs.info(`Validating input schema stored at ${inputSchemaPath}`);
+        } else {
+            outputs.info(`Validating input schema embedded in "${LOCAL_CONFIG_PATH}"`);
         }
 
-        validateInputSchema(validator, inputSchemaObj); // This one throws an error in a case of invalid schema.
+        const validator = new Ajv({ strict: false });
+        validateInputSchema(validator, inputSchema); // This one throws an error in a case of invalid schema.
         outputs.success('Input schema is valid.');
     }
 }
 
-ValidateInputSchemaCommand.description = 'Validates INPUT_SCHEMA.json file and prints errors found.';
+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 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
+3. JSON file at .actor/INPUT_SCHEMA.json
+4. JSON file at INPUT_SCHEMA.json
+
+You can also pass any custom path to your input schema to have it validated instead.
+`;
 
 ValidateInputSchemaCommand.args = [
     {

package/src/lib/consts.js

@@ -6,11 +6,14 @@ exports.DEFAULT_LOCAL_STORAGE_DIR = 'storage';
 
 exports.LEGACY_LOCAL_STORAGE_DIR = 'apify_storage';
 
+exports.ACTOR_SPECIFICATION_VERSION = 1;
+
 exports.EMPTY_LOCAL_CONFIG = {
+    actorSpecification: exports.ACTOR_SPECIFICATION_VERSION,
     name: null,
     version: '0.0',
     buildTag: 'latest',
-    env: null,
+    environmentVariables: {},
 };
 
 exports.GLOBAL_CONFIGS_FOLDER = path.join(os.homedir(), '.apify');
@@ -19,7 +22,13 @@ exports.AUTH_FILE_PATH = path.join(exports.GLOBAL_CONFIGS_FOLDER, 'auth.json');
 
 exports.SECRETS_FILE_PATH = path.join(exports.GLOBAL_CONFIGS_FOLDER, 'secrets.json');
 
-exports.LOCAL_CONFIG_NAME = 'apify.json';
+exports.DEPRECATED_LOCAL_CONFIG_NAME = 'apify.json';
+
+exports.ACTOR_SPECIFICATION_FOLDER = '.actor';
+
+exports.LOCAL_CONFIG_NAME = 'actor.json';
+
+exports.LOCAL_CONFIG_PATH = path.join(exports.ACTOR_SPECIFICATION_FOLDER, exports.LOCAL_CONFIG_NAME);
 
 exports.INPUT_FILE_REG_EXP = new RegExp(`^${KEY_VALUE_STORE_KEYS.INPUT}\\..*`);
 

package/src/lib/input_schema.js

@@ -0,0 +1,70 @@
+const fs = require('fs');
+const path = require('path');
+const { ACTOR_SPECIFICATION_FOLDER } = require('./consts');
+const { getLocalConfig, getJsonFileContent } = require('./utils');
+
+const DEFAULT_INPUT_SCHEMA_PATHS = [
+    '.actor/INPUT_SCHEMA.json',
+    './INPUT_SCHEMA.json',
+];
+
+/**
+ * Return the input schema from the default location.
+ *
+ * When the input schema does not exist, null is returned for schema.
+ * In such a acase, path would be set to the location
+ * where the input schema would be expected to be found (and e.g. can be created there).
+ *
+ * @param {string} forcePath
+ * @returns {{inputSchema: object, inputSchemaPath: string | null}}
+ */
+const readInputSchema = async (forcePath) => {
+    if (forcePath) {
+        return {
+            inputSchema: await getJsonFileContent(forcePath),
+            inputSchemaPath: forcePath,
+        };
+    }
+
+    const localConfig = getLocalConfig();
+
+    if (typeof localConfig?.input === 'object') {
+        return {
+            inputSchema: localConfig.input,
+            inputSchemaPath: null,
+        };
+    }
+
+    if (typeof localConfig?.input === 'string') {
+        const fullPath = path.join(ACTOR_SPECIFICATION_FOLDER, localConfig.input);
+        return {
+            inputSchema: await getJsonFileContent(fullPath),
+            inputSchemaPath: fullPath,
+        };
+    }
+
+    if (fs.existsSync(DEFAULT_INPUT_SCHEMA_PATHS[0])) {
+        return {
+            inputSchema: await getJsonFileContent(DEFAULT_INPUT_SCHEMA_PATHS[0]),
+            inputSchemaPath: DEFAULT_INPUT_SCHEMA_PATHS[0],
+        };
+    }
+
+    if (fs.existsSync(DEFAULT_INPUT_SCHEMA_PATHS[1])) {
+        return {
+            inputSchema: await getJsonFileContent(DEFAULT_INPUT_SCHEMA_PATHS[1]),
+            inputSchemaPath: DEFAULT_INPUT_SCHEMA_PATHS[1],
+        };
+    }
+
+    // If not input schema has been found so far, return the first default path
+    // where the input schema would be expected.
+    return {
+        inputSchema: null,
+        inputSchemaPath: DEFAULT_INPUT_SCHEMA_PATHS[0],
+    };
+};
+
+module.exports = {
+    readInputSchema,
+};