apify-cli 1.4.1 → 1.4.2-beta.1

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+<!-- git-cliff-unreleased-start -->
+
+## 1.4.2 - **not yet released**
+
+### 🚀 Features
+
+- Add execution context to telemetry events ([#1074](https://github.com/apify/apify-cli/pull/1074)) ([9288ff8](https://github.com/apify/apify-cli/commit/9288ff886864acd78b5e06b5ff13096774bd81f6)) by [@patrikbraborec](https://github.com/patrikbraborec)
+
+<!-- git-cliff-unreleased-end -->
+
 ## [1.4.1](https://github.com/apify/apify-cli/releases/tag/v1.4.1) (2026-04-02)
 
 ### 🐛 Bug Fixes
@@ -46,6 +56,10 @@ All notable changes to this project will be documented in this file.
 
 ## [1.2.1](https://github.com/apify/apify-cli/releases/tag/v1.2.1) (2026-01-06)
 
+### 🔧 CI/CD
+
+- Fix release flow permissions ([#988](https://github.com/apify/apify-cli/pull/988)) ([a9d0d90](https://github.com/apify/apify-cli/commit/a9d0d9013f42e48bfcdddbc467e995b1655cf853)) by [@vladfrangu](https://github.com/vladfrangu)
+
 ## [1.2.0](https://github.com/apify/apify-cli/releases/tag/v1.2.0) (2026-01-06)
 
 ### 🚀 Features

package/README.md

@@ -1,283 +1,129 @@
-# Apify command-line interface (Apify CLI)
+# Apify CLI
 
 [![NPM version](https://badge.fury.io/js/apify-cli.svg)](https://www.npmjs.com/package/apify-cli)
 [![GitHub workflow](https://github.com/apify/apify-cli/actions/workflows/check.yaml/badge.svg)](https://github.com/apify/apify-cli/actions/workflows/check.yaml)
 
-Apify command-line interface (Apify CLI) helps you create, develop, build and run
-[Apify Actors](https://www.apify.com/actors),
-and manage the Apify cloud platform from any computer.
+Apify CLI is the command-line tool for creating, developing, and deploying [Apify Actors](https://www.apify.com/actors), and for managing the Apify cloud platform from your terminal.
 
-Apify Actors are cloud programs that can perform arbitrary web scraping, automation or data processing job.
-They accept input, perform their job and generate output.
-While you can develop Actors in an online IDE directly in the [Apify web application](https://console.apify.com/),
-for complex projects it is more convenient to develop Actors locally on your computer
-using <a href="https://github.com/apify/apify-sdk-js">Apify SDK</a>
-and only push the Actors to the Apify cloud during deployment.
-This is where the Apify CLI comes in.
+## Features
 
-Note that Actors running on the Apify platform are executed in Docker containers, so with an appropriate `Dockerfile`
-you can build your Actors in any programming language.
-However, we recommend using JavaScript / Node.js, for which we provide most libraries and support.
+- Create, develop, and deploy Apify Actors from your terminal
+- Run Actors locally for development and testing, or in the Apify cloud
+- Manage Actors, datasets, key-value stores, and request queues
+- Manage secret environment variables used by your Actors
+- Works with any programming language — Actors run as Docker containers on the platform
 
-## Installation
-
-### Via bundles
-
-#### MacOS / Unix
-
-```bash
-curl -fsSL https://apify.com/install-cli.sh | bash
-```
-
-#### Windows
-
-```powershell
-irm https://apify.com/install-cli.ps1 | iex
-```
-
-### Via Homebrew
+## Quick start
 
-On macOS (or Linux), you can install the Apify CLI via the [Homebrew package manager](https://brew.sh).
-
-```bash
-brew install apify-cli
-```
+1. **Install the CLI** (macOS / Linux):
 
-### Via NPM
+   ```bash
+   curl -fsSL https://apify.com/install-cli.sh | bash
+   ```
 
-First, make sure you have [Node.js](https://nodejs.org) version 22 or higher with NPM installed on your computer:
+   For Windows and other installation options, see [Installation](#installation).
 
-```bash
-node --version
-npm --version
-```
+2. **Log in** with your [Apify API token](https://console.apify.com/settings/integrations):
 
-Install or upgrade Apify CLI by running:
+   ```bash
+   apify login
+   ```
 
-```bash
-npm install -g apify-cli
-```
-
-Alternatively, you can use [fnm (Fast Node Manager)](https://github.com/Schniz/fnm) and install Apify CLI only into a selected user-level Node version without requiring root privileges:
-
-```bash
-fnm install 22
-fnm use 22
-npm install -g apify-cli
-```
-
-Finally, verify that Apify CLI was installed correctly by running:
-
-```bash
-apify --version
-```
-
-> You can also skip the manual global installation altogether and use `npx apify-cli` with all the following commands instead.
-
-## Basic usage
-
-The following examples demonstrate the basic usage of Apify CLI.
-
-### Create a new Actor from scratch
-
-```bash
-apify create my-hello-world
-```
+3. **Create, run, and deploy** your first Actor:
 
-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.
+   ```bash
+   apify create # it will walk you through an interactive wizard
+   cd my-actor
+   apify run
+   apify push
+   ```
 
-> 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
-
-```bash
-cd ./my/awesome/project
-apify init
-```
-
-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:
-
-```text
-{
-    ...
-    "scripts": {
-        "start": "node your_main_file.js",
-    },
-    ...
-}
-```
-
-You can find more information about by running `apify help run`.
-
-### Create a new Actor from Scrapy project
-
-If you want to run a Scrapy project on Apify platform, follow the [Scrapy integration guide](https://docs.apify.com/cli/docs/integrating-scrapy).
+## Installation
 
-### Run the Actor locally
+### macOS / Linux (bundle, recommended)
 
 ```bash
-cd my-hello-world
-apify run
+curl -fsSL https://apify.com/install-cli.sh | bash
 ```
 
-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
+### macOS / Linux (Homebrew)
 
 ```bash
-apify login
+brew install apify-cli
 ```
 
-Before you can interact with the Apify cloud, you need to [create an Apify account](https://console.apify.com/)
-and log in to it using the above command. You will be prompted for
-your [Apify API token](https://console.apify.com/settings/integrations).
-Note that the command will store the API token and other sensitive information to `~/.apify`.
+### Windows
 
-### Push the Actor to the Apify cloud
-
-```bash
-apify push
+```powershell
+irm https://apify.com/install-cli.ps1 | iex
 ```
 
-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.
+### npm (cross-platform)
 
-### Run an Actor on the Apify cloud
+Requires [Node.js](https://nodejs.org) 22 or higher:
 
 ```bash
-apify call
+npm install -g apify-cli
 ```
 
-Runs the Actor corresponding to the current directory on the Apify platform.
+You can also run the CLI without a global install via `npx apify-cli <command>`.
 
-This command can also be used to run other Actors, for example:
+Verify the installation:
 
 ```bash
-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.
-Make sure you commit this file to the Git repository.
-
-For example, `.actor/actor.json` file can look as follows:
-
-```json
-{
-  "actorSpecification": 1,
-  "name": "name-of-my-scraper",
-  "version": "0.0",
-  "buildTag": "latest",
-  "environmentVariables": {
-    "MYSQL_USER": "my_username",
-    "MYSQL_PASSWORD": "@mySecretPassword"
-  },
-  "dockerfile": "./Dockerfile",
-  "readme": "./ACTOR.md",
-  "input": "./input_schema.json",
-  "storages": {
-    "dataset": "./dataset_schema.json"
-  }
-}
+apify --version
 ```
 
-**`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.
-
-**`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.
+## Commands
 
-**`Input` field**\
-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.
+The table below lists the most common commands. For the full reference, see the [command reference](https://docs.apify.com/cli/docs/reference).
 
-**`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).
+| Command         | Description                                               |
+| --------------- | --------------------------------------------------------- |
+| `apify create`  | Create a new Actor project from a template                |
+| `apify init`    | Initialize an existing project as an Actor                |
+| `apify run`     | Run the Actor locally                                     |
+| `apify login`   | Authenticate with the Apify platform                      |
+| `apify logout`  | Log out of the Apify platform                             |
+| `apify push`    | Deploy the Actor to the Apify cloud                       |
+| `apify pull`    | Pull an Actor from the cloud to your local machine        |
+| `apify call`    | Run the Actor on the Apify cloud                          |
+| `apify builds`  | Manage Actor builds (`create`, `info`, `ls`, `log`, `rm`) |
+| `apify secrets` | Manage secret environment variables                       |
+| `apify help`    | Show help for any command                                 |
 
-**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)._
+Actor configuration lives in `.actor/actor.json`. See the [Actor configuration docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json) for the full schema (name, version, build tag, environment variables, Dockerfile, input schema, storages).
 
-## Environment variables
+## Documentation
 
-There are two options how you can set up environment variables for Actors.
+- [Apify CLI documentation](https://docs.apify.com/cli)
+- [Command reference](https://docs.apify.com/cli/docs/reference)
+- [Actor development guide](https://docs.apify.com/platform/actors/development)
+- [Apify platform documentation](https://docs.apify.com/platform)
 
-### Set up environment variables in .actor/actor.json
+## Telemetry
 
-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.
+Apify CLI collects anonymous usage data to help us improve the tool and the Apify platform. See [Telemetry](https://docs.apify.com/cli/docs/telemetry) for details on what is collected.
 
-```json
-{
-  "actorSpecification": 1,
-  "name": "dataset-to-mysql",
-  "version": "0.1",
-  "buildTag": "latest",
-  "environmentVariables": {
-    "MYSQL_USER": "my_username",
-    "MYSQL_PASSWORD": "@mySecretPassword"
-  }
-}
-```
-
-### 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.
-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
-{
-  "actorSpecification": 1,
-  "name": "dataset-to-mysql",
-  "version": "0.1",
-  "buildTag": "latest"
-}
-```
-
-#### How to set secret environment variables in .actor/actor.json
-
-CLI provides commands to manage secrets environment variables. Secrets are stored to the `~/.apify` directory.
-You can add a new secret using the command:
+To opt out, either run:
 
 ```bash
-apify secrets:add mySecretPassword pwd1234
+apify telemetry disable
 ```
 
-After adding a new secret you can use the secret in `.actor/actor.json`.
-
-```text
-{
-    "actorSpecification": 1,
-    "name": "dataset-to-mysql",
-    ...
-    "environmentVariables": {
-      "MYSQL_PASSWORD": "@mySecretPassword"
-    },
-    ...
-}
-```
+or set the `APIFY_CLI_DISABLE_TELEMETRY=1` environment variable.
 
-### Need help?
+## Contributing
 
-To see all CLI commands simply run:
+Contributions are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) for local setup, code style, test categories, and PR guidelines.
 
-```bash
-apify help
-```
-
-To get information about a specific command run:
-
-```bash
-apify help COMMAND
-```
+## Feedback & support
 
-Still haven't found what you were looking for? Please go to [Apify Help center](https://www.apify.com/help)
-or [contact us](https://www.apify.com/contact).
+- Report bugs or request features via [GitHub Issues](https://github.com/apify/apify-cli/issues)
+- Browse the [Apify Help Center](https://www.apify.com/help)
+- [Contact Apify support](https://www.apify.com/contact)
+- Join the community on [Discord](https://discord.gg/crawlee-apify-801163717915574323)
 
-## Command reference
+## License
 
-See a list of all our commands on the [reference page](https://docs.apify.com/cli/docs/reference)
+[Apache-2.0](./LICENSE.md)