apify-cli 0.7.0-beta.0 → 0.7.1-beta.1

package/README.md

@@ -235,6 +235,11 @@ or [contact us](https://www.apify.com/contact).
 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 call [ACTID]`](#apify-call-actid)
 * [`apify create [ACTORNAME]`](#apify-create-actorname)
 * [`apify info`](#apify-info)
@@ -248,6 +253,93 @@ This section contains printouts of `apify help` for all commands.
 * [`apify secrets:rm NAME`](#apify-secretsrm-name)
 * [`apify vis [PATH]`](#apify-vis-path)
 
+## `apify actor`
+
+Commands are designed to be used in actor runs. All commands are in PoC state, do not use in production environments.
+
+```
+USAGE
+  $ apify actor
+```
+
+_See code: [src/commands/actor/index.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/actor/index.js)_
+
+## `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
+```
+
+_See code: [src/commands/actor/get-input.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/actor/get-input.js)_
+
+## `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
+
+ARGUMENTS
+  KEY  Key of the record in key-value store
+```
+
+_See code: [src/commands/actor/get-value.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/actor/get-value.js)_
+
+## `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]
+
+ARGUMENTS
+  ITEM  JSON string with one object or array of objects containing data to be stored in the default dataset.
+
+DESCRIPTION
+  It is possible to pass data using item argument or stdin.
+  Passing data using argument:
+  $ apify actor:push-data {"foo": "bar"}
+  Passing data using stdin with pipe:
+  $ cat ./test.json | apify actor:push-data
+```
+
+_See code: [src/commands/actor/push-data.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/actor/push-data.js)_
+
+## `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]
+
+ARGUMENTS
+  KEY    Key of the record in key-value store.
+
+  VALUE  Record data, which can be one of the following values:
+         - If empty, the record in the key-value store is deleted.
+         - If no `contentType` flag is specified, value is expected to be any JSON string value.
+         - If options.contentType is set, value is taken as is.
+
+OPTIONS
+  -c, --contentType=contentType  Specifies a custom MIME content type of the record. By default "application/json" is
+                                 used.
+
+DESCRIPTION
+  It is possible to pass data using argument or stdin.
+  Passing data using argument:
+  $ 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
+```
+
+_See code: [src/commands/actor/set-value.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/actor/set-value.js)_
+
 ## `apify call [ACTID]`
 
 Runs a specific actor remotely on the Apify cloud platform.
@@ -267,11 +359,11 @@ OPTIONS
   -w, --wait-for-finish=wait-for-finish  Seconds for waiting to run to finish, if no value passed, it waits forever.
 
 DESCRIPTION
-  The actor is run under your current Apify account, therefore you need to be logged in by calling "apify login". It
+  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.6.7/src/commands/call.js)_
+_See code: [src/commands/call.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/call.js)_
 
 ## `apify create [ACTORNAME]`
 
@@ -290,7 +382,7 @@ OPTIONS
                            available template names.
 ```
 
-_See code: [src/commands/create.js](https://github.com/apify/apify-cli/blob/v0.6.7/src/commands/create.js)_
+_See code: [src/commands/create.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/create.js)_
 
 ## `apify info`
 
@@ -304,7 +396,7 @@ DESCRIPTION
   The information is printed to the console.
 ```
 
-_See code: [src/commands/info.js](https://github.com/apify/apify-cli/blob/v0.6.7/src/commands/info.js)_
+_See code: [src/commands/info.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/info.js)_
 
 ## `apify init [ACTORNAME]`
 
@@ -318,13 +410,13 @@ ARGUMENTS
   ACTORNAME  Name of the actor. If not provided, you will be prompted for it.
 
 DESCRIPTION
-  The command only creates the "apify.json" file and the "apify_storage" directory in the current directory, but will
+  The command only creates the "apify.json" file and the "apify_storage" directory in the current directory, but will 
   not touch anything else.
 
   WARNING: The directory at "apify_storage" will be overwritten if it already exists.
 ```
 
-_See code: [src/commands/init.js](https://github.com/apify/apify-cli/blob/v0.6.7/src/commands/init.js)_
+_See code: [src/commands/init.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/init.js)_
 
 ## `apify login`
 
@@ -338,11 +430,11 @@ OPTIONS
   -t, --token=token  [Optional] Apify API token
 
 DESCRIPTION
-  The API token and other account information is stored in the ~/.apify directory, from where it is read by all other
+  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.js](https://github.com/apify/apify-cli/blob/v0.6.7/src/commands/login.js)_
+_See code: [src/commands/login.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/login.js)_
 
 ## `apify logout`
 
@@ -357,7 +449,7 @@ DESCRIPTION
    call "apify login".
 ```
 
-_See code: [src/commands/logout.js](https://github.com/apify/apify-cli/blob/v0.6.7/src/commands/logout.js)_
+_See code: [src/commands/logout.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/logout.js)_
 
 ## `apify push [ACTORID]`
 
@@ -384,15 +476,15 @@ OPTIONS
                                          should be pushed. By default, it is taken from the "apify.json" file.
 
 DESCRIPTION
-  The actor settings are read from the "apify.json" file in the current directory, but they can be overridden using
+  The actor settings are read from the "apify.json" file in the current directory, but they can be overridden using 
   command-line options.
-  NOTE: If the source files are smaller than 3 MB then they are uploaded as
+  NOTE: If the source files are smaller than 3 MB then they are uploaded as 
   "Multiple source files", otherwise they are uploaded as "Zip file".
 
   WARNING: If the target actor already exists in your Apify account, it will be overwritten!
 ```
 
-_See code: [src/commands/push.js](https://github.com/apify/apify-cli/blob/v0.6.7/src/commands/push.js)_
+_See code: [src/commands/push.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/push.js)_
 
 ## `apify run`
 
@@ -418,11 +510,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 "apify_storage" directory, rather than on the Apify platform.
 
-  NOTE: You can override the default behaviour of command overriding npm start script value in a package.json file. You
+  NOTE: 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.
 ```
 
-_See code: [src/commands/run.js](https://github.com/apify/apify-cli/blob/v0.6.7/src/commands/run.js)_
+_See code: [src/commands/run.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/run.js)_
 
 ## `apify secrets`
 
@@ -448,7 +540,7 @@ DESCRIPTION
    of the actor.
 ```
 
-_See code: [src/commands/secrets/index.js](https://github.com/apify/apify-cli/blob/v0.6.7/src/commands/secrets/index.js)_
+_See code: [src/commands/secrets/index.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/secrets/index.js)_
 
 ## `apify secrets:add NAME VALUE`
 
@@ -466,7 +558,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.6.7/src/commands/secrets/add.js)_
+_See code: [src/commands/secrets/add.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/secrets/add.js)_
 
 ## `apify secrets:rm NAME`
 
@@ -480,7 +572,7 @@ ARGUMENTS
   NAME  Name of the secret
 ```
 
-_See code: [src/commands/secrets/rm.js](https://github.com/apify/apify-cli/blob/v0.6.7/src/commands/secrets/rm.js)_
+_See code: [src/commands/secrets/rm.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/secrets/rm.js)_
 
 ## `apify vis [PATH]`
 
@@ -494,5 +586,5 @@ ARGUMENTS
   PATH  Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.
 ```
 
-_See code: [src/commands/vis.js](https://github.com/apify/apify-cli/blob/v0.6.7/src/commands/vis.js)_
+_See code: [src/commands/vis.js](https://github.com/apify/apify-cli/blob/v0.7.1/src/commands/vis.js)_
 <!-- commandsstop -->