apify-cli 1.0.0-beta.63 → 1.0.0-beta.64
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -36
- package/dist/.tsbuildinfo +1 -1
- package/dist/commands/call.js +3 -3
- package/dist/commands/create.js +3 -3
- package/dist/commands/push.js +9 -9
- package/dist/lib/actor.d.ts +1 -1
- package/dist/lib/actor.js +1 -1
- package/dist/lib/utils.d.ts +4 -4
- package/dist/lib/utils.js +5 -5
- package/oclif.manifest.json +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -76,25 +76,25 @@ apify-cli/0.10.0 darwin-x64 node-v16.14.2
|
|
|
76
76
|
|
|
77
77
|
The following examples demonstrate the basic usage of Apify CLI.
|
|
78
78
|
|
|
79
|
-
### Create a new
|
|
79
|
+
### Create a new Actor from scratch
|
|
80
80
|
|
|
81
81
|
```bash
|
|
82
82
|
apify create my-hello-world
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
-
First, you will be prompted to select a template with the boilerplate for the
|
|
85
|
+
First, you will be prompted to select a template with the boilerplate for the Actor, to help you get started quickly.
|
|
86
86
|
The command will create a directory called `my-hello-world` that contains a Node.js project
|
|
87
|
-
for the
|
|
87
|
+
for the Actor and a few configuration files.
|
|
88
88
|
|
|
89
89
|
> If you decided to skip the installation and go with `npx`, the command will be `npx apify-cli create my-hello-world`.
|
|
90
90
|
|
|
91
|
-
### Create a new
|
|
91
|
+
### Create a new Actor from existing project
|
|
92
92
|
|
|
93
93
|
```bash
|
|
94
94
|
cd ./my/awesome/project
|
|
95
95
|
apify init
|
|
96
96
|
```
|
|
97
|
-
This command will only set up local
|
|
97
|
+
This command will only set up local Actor development environment in an existing directory,
|
|
98
98
|
i.e. it will create the `.actor/actor.json` file and `apify_storage` directory.
|
|
99
99
|
|
|
100
100
|
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`.
|
|
|
113
113
|
|
|
114
114
|
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).
|
|
115
115
|
|
|
116
|
-
### Run the
|
|
116
|
+
### Run the Actor locally
|
|
117
117
|
|
|
118
118
|
```bash
|
|
119
119
|
cd my-hello-world
|
|
120
120
|
apify run
|
|
121
121
|
```
|
|
122
122
|
|
|
123
|
-
This command runs the
|
|
123
|
+
This command runs the Actor on your local machine.
|
|
124
124
|
Now's your chance to develop the logic - or magic :smirk:
|
|
125
125
|
|
|
126
126
|
### Login with your Apify account
|
|
@@ -135,21 +135,21 @@ your [Apify API token](https://console.apify.com/account#/integrations).
|
|
|
135
135
|
Note that the command will store the API token and other sensitive information to `~/.apify`.
|
|
136
136
|
|
|
137
137
|
|
|
138
|
-
### Push the
|
|
138
|
+
### Push the Actor to the Apify cloud
|
|
139
139
|
|
|
140
140
|
```bash
|
|
141
141
|
apify push
|
|
142
142
|
```
|
|
143
143
|
|
|
144
|
-
This command uploads your project to the Apify cloud and builds an
|
|
144
|
+
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.
|
|
145
145
|
|
|
146
|
-
### Run an
|
|
146
|
+
### Run an Actor on the Apify cloud
|
|
147
147
|
|
|
148
148
|
```bash
|
|
149
149
|
apify call
|
|
150
150
|
```
|
|
151
151
|
|
|
152
|
-
Runs the
|
|
152
|
+
Runs the Actor corresponding to the current directory on the Apify platform.
|
|
153
153
|
|
|
154
154
|
This command can also be used to run other Actors, for example:
|
|
155
155
|
|
|
@@ -159,8 +159,8 @@ apify call apify/hello-world
|
|
|
159
159
|
|
|
160
160
|
### So what's in this .actor/actor.json file?
|
|
161
161
|
|
|
162
|
-
This file associates your local development project with an
|
|
163
|
-
It contains information such as
|
|
162
|
+
This file associates your local development project with an Actor on the Apify platform.
|
|
163
|
+
It contains information such as Actor name, version, build tag and environment variables.
|
|
164
164
|
Make sure you commit this file to the Git repository.
|
|
165
165
|
|
|
166
166
|
For example, `.actor/actor.json` file can look as follows:
|
|
@@ -186,7 +186,7 @@ For example, `.actor/actor.json` file can look as follows:
|
|
|
186
186
|
```
|
|
187
187
|
|
|
188
188
|
**`Dockerfile` field**\
|
|
189
|
-
If you specify the path to your Docker file under the `dockerfile` field, this file will be used for
|
|
189
|
+
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.
|
|
190
190
|
|
|
191
191
|
**`Readme` field** \
|
|
192
192
|
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
|
|
|
195
195
|
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.
|
|
196
196
|
|
|
197
197
|
**`Storages.dataset` field**\
|
|
198
|
-
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
|
|
198
|
+
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).
|
|
199
199
|
|
|
200
200
|
**Note on migration from deprecated config "apify.json"**\
|
|
201
|
-
*Note that previously,
|
|
201
|
+
*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).*
|
|
202
202
|
|
|
203
203
|
## Environment variables
|
|
204
204
|
|
|
205
205
|
There are two options how you can set up environment variables for Actors.
|
|
206
206
|
|
|
207
207
|
### Set up environment variables in .actor/actor.json
|
|
208
|
-
All keys from `env` will be set as environment variables into Apify platform after you push
|
|
208
|
+
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.
|
|
209
209
|
```json
|
|
210
210
|
{
|
|
211
211
|
"actorSpecification": 1,
|
|
@@ -220,7 +220,7 @@ All keys from `env` will be set as environment variables into Apify platform aft
|
|
|
220
220
|
```
|
|
221
221
|
|
|
222
222
|
### Set up environment variables in Apify Console
|
|
223
|
-
In [Apify Console](https://console.apify.com/actors) select your
|
|
223
|
+
In [Apify Console](https://console.apify.com/actors) select your Actor, you can set up variables into Source tab.
|
|
224
224
|
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.
|
|
225
225
|
```json
|
|
226
226
|
{
|
|
@@ -307,7 +307,7 @@ DESCRIPTION
|
|
|
307
307
|
Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
|
|
308
308
|
```
|
|
309
309
|
|
|
310
|
-
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
310
|
+
_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/actor/index.ts)_
|
|
311
311
|
|
|
312
312
|
## `apify actor get-input`
|
|
313
313
|
|
|
@@ -321,7 +321,7 @@ DESCRIPTION
|
|
|
321
321
|
Gets the Actor input value from the default key-value store associated with the Actor run.
|
|
322
322
|
```
|
|
323
323
|
|
|
324
|
-
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
324
|
+
_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/actor/get-input.ts)_
|
|
325
325
|
|
|
326
326
|
## `apify actor get-value KEY`
|
|
327
327
|
|
|
@@ -338,7 +338,7 @@ DESCRIPTION
|
|
|
338
338
|
Gets a value from the default key-value store associated with the Actor run.
|
|
339
339
|
```
|
|
340
340
|
|
|
341
|
-
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
341
|
+
_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/actor/get-value.ts)_
|
|
342
342
|
|
|
343
343
|
## `apify actor push-data [ITEM]`
|
|
344
344
|
|
|
@@ -360,7 +360,7 @@ DESCRIPTION
|
|
|
360
360
|
$ cat ./test.json | apify actor push-data
|
|
361
361
|
```
|
|
362
362
|
|
|
363
|
-
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
363
|
+
_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/actor/push-data.ts)_
|
|
364
364
|
|
|
365
365
|
## `apify actor set-value KEY [VALUE]`
|
|
366
366
|
|
|
@@ -389,7 +389,7 @@ DESCRIPTION
|
|
|
389
389
|
$ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain
|
|
390
390
|
```
|
|
391
391
|
|
|
392
|
-
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
392
|
+
_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/actor/set-value.ts)_
|
|
393
393
|
|
|
394
394
|
## `apify call [ACTORID]`
|
|
395
395
|
|
|
@@ -415,7 +415,7 @@ DESCRIPTION
|
|
|
415
415
|
takes input for the Actor from the default local key-value store by default.
|
|
416
416
|
```
|
|
417
417
|
|
|
418
|
-
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
418
|
+
_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/call.ts)_
|
|
419
419
|
|
|
420
420
|
## `apify create [ACTORNAME]`
|
|
421
421
|
|
|
@@ -440,7 +440,7 @@ DESCRIPTION
|
|
|
440
440
|
Creates a new Actor project directory from a selected boilerplate template.
|
|
441
441
|
```
|
|
442
442
|
|
|
443
|
-
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
443
|
+
_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/create.ts)_
|
|
444
444
|
|
|
445
445
|
## `apify help [COMMAND]`
|
|
446
446
|
|
|
@@ -475,7 +475,7 @@ DESCRIPTION
|
|
|
475
475
|
The information is printed to the console.
|
|
476
476
|
```
|
|
477
477
|
|
|
478
|
-
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
478
|
+
_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/info.ts)_
|
|
479
479
|
|
|
480
480
|
## `apify init [ACTORNAME]`
|
|
481
481
|
|
|
@@ -503,7 +503,7 @@ DESCRIPTION
|
|
|
503
503
|
WARNING: The directory at "storage" will be overwritten if it already exists.
|
|
504
504
|
```
|
|
505
505
|
|
|
506
|
-
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
506
|
+
_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/init.ts)_
|
|
507
507
|
|
|
508
508
|
## `apify login`
|
|
509
509
|
|
|
@@ -524,7 +524,7 @@ DESCRIPTION
|
|
|
524
524
|
"apify" commands. To log out, call "apify logout".
|
|
525
525
|
```
|
|
526
526
|
|
|
527
|
-
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
527
|
+
_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/login.ts)_
|
|
528
528
|
|
|
529
529
|
## `apify logout`
|
|
530
530
|
|
|
@@ -540,7 +540,7 @@ DESCRIPTION
|
|
|
540
540
|
call "apify login".
|
|
541
541
|
```
|
|
542
542
|
|
|
543
|
-
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
543
|
+
_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/logout.ts)_
|
|
544
544
|
|
|
545
545
|
## `apify pull [ACTORID]`
|
|
546
546
|
|
|
@@ -562,7 +562,7 @@ DESCRIPTION
|
|
|
562
562
|
cloned. If it is defined as Web IDE, it will fetch the files.
|
|
563
563
|
```
|
|
564
564
|
|
|
565
|
-
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
565
|
+
_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/pull.ts)_
|
|
566
566
|
|
|
567
567
|
## `apify push [ACTORID]`
|
|
568
568
|
|
|
@@ -600,7 +600,7 @@ DESCRIPTION
|
|
|
600
600
|
overwritten with --force flag.
|
|
601
601
|
```
|
|
602
602
|
|
|
603
|
-
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
603
|
+
_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/push.ts)_
|
|
604
604
|
|
|
605
605
|
## `apify run`
|
|
606
606
|
|
|
@@ -632,7 +632,7 @@ DESCRIPTION
|
|
|
632
632
|
package.json file. You can set up your own main file or environment variables by changing it.
|
|
633
633
|
```
|
|
634
634
|
|
|
635
|
-
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
635
|
+
_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/run.ts)_
|
|
636
636
|
|
|
637
637
|
## `apify secrets`
|
|
638
638
|
|
|
@@ -662,7 +662,7 @@ DESCRIPTION
|
|
|
662
662
|
of the Actor.
|
|
663
663
|
```
|
|
664
664
|
|
|
665
|
-
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
665
|
+
_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/secrets/index.ts)_
|
|
666
666
|
|
|
667
667
|
## `apify secrets add NAME VALUE`
|
|
668
668
|
|
|
@@ -681,7 +681,7 @@ DESCRIPTION
|
|
|
681
681
|
The secrets are stored to a file at ~/.apify
|
|
682
682
|
```
|
|
683
683
|
|
|
684
|
-
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
684
|
+
_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/secrets/add.ts)_
|
|
685
685
|
|
|
686
686
|
## `apify secrets rm NAME`
|
|
687
687
|
|
|
@@ -698,7 +698,7 @@ DESCRIPTION
|
|
|
698
698
|
Removes the secret.
|
|
699
699
|
```
|
|
700
700
|
|
|
701
|
-
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
701
|
+
_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/secrets/rm.ts)_
|
|
702
702
|
|
|
703
703
|
## `apify validate-schema [PATH]`
|
|
704
704
|
|
|
@@ -723,5 +723,5 @@ DESCRIPTION
|
|
|
723
723
|
You can also pass any custom path to your input schema to have it validated instead.
|
|
724
724
|
```
|
|
725
725
|
|
|
726
|
-
_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.
|
|
726
|
+
_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v1.0.0-beta.64/src/commands/validate-schema.ts)_
|
|
727
727
|
<!-- commandsstop -->
|