Command reference
The Apify CLI provides tools for managing your Apify projects and resources from the command line. Use these commands to develop Actors locally, deploy them to Apify platform, manage storage, orchestrate runs, and handle account configuration.
This reference guide documents available commands, their options, and common usage patterns, to efficiently work with Apify platform.
General
The general commands provide basic functionality for getting help and information about the Apify CLI.
apify help
DESCRIPTION
Prints out help about a command, or all available commands.
USAGE
$ apify help [commandString] [--skill]
ARGUMENTS
commandString The command to get help for.
FLAGS
--skill Print the Apify CLI agent skill (guidance for driving
`apify` from agents).
apify upgrade
DESCRIPTION
Checks that installed Apify CLI version is up to date.
USAGE
$ apify upgrade [-f] [--version <value>]
FLAGS
-f, --force [DEPRECATED] This flag is now
ignored, as running the command manually will always check
for the latest version.
--version=<value> The version of the CLI to upgrade to. If
not provided, the latest version will be used.
apify api
DESCRIPTION
Makes an authenticated HTTP request to the Apify API and prints the response.
The endpoint can be a relative path (e.g. "acts", "v2/acts", or "/v2/acts");
the "v2/" prefix is added automatically if omitted.
Use --list-endpoints to see all available API endpoints.
USAGE
$ apify api [methodOrEndpoint] [endpoint] [-d <value>]