feat: rewrite command descriptions (#727)

Co-authored-by: Adam Kliment <[email protected]>

Author: TC-MO

src/commands/actor/index.ts

@@ -1,8 +1,7 @@
 import { ApifyCommand } from '../../lib/apify_command.js';
 
 export class ActorIndexCommand extends ApifyCommand<typeof ActorIndexCommand> {
-	static override description =
-		'Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.\n';
+	static override description = 'Manages runtime data operations inside of a running Actor.';
 
 	async run() {
 		await this.printHelp();

src/commands/actor/push-data.ts

@@ -7,12 +7,12 @@ import { error } from '../../lib/outputs.js';
 
 export class PushDataCommand extends ApifyCommand<typeof PushDataCommand> {
 	static override description =
-		'Stores an object or an array of objects to the default dataset of the Actor run.\n' +
-		'It is possible to pass data using item argument or stdin.\n' +
-		'Passing data using argument:\n' +
-		'$ apify actor push-data {"foo": "bar"}\n' +
-		'Passing data using stdin with pipe:\n' +
-		'$ cat ./test.json | apify actor push-data\n';
+		"Saves data to Actor's run default dataset.\n\n" +
+		'Accept input as:\n' +
+		'  - JSON argument:\n' +
+		'  $ apify actor push-data {"key": "value"}\n' +
+		'  - Piped stdin:\n' +
+		'  $ cat ./test.json | apify actor push-data';
 
 	static override args = {
 		item: Args.string({

src/commands/actor/set-value.ts

@@ -5,12 +5,12 @@ import { ApifyCommand } from '../../lib/apify_command.js';
 
 export class SetValueCommand extends ApifyCommand<typeof SetValueCommand> {
 	static override description =
-		'Sets or removes record into the default KeyValueStore associated with the Actor run.\n' +
-		'It is possible to pass data using argument or stdin.\n' +
+		'Sets or removes record into the default key-value store associated with the Actor run.\n\n' +
+		'It is possible to pass data using argument or stdin.\n\n' +
 		'Passing data using argument:\n' +
-		'$ apify actor set-value KEY my-value\n' +
+		'$ apify actor set-value KEY my-value\n\n' +
 		'Passing data using stdin with pipe:\n' +
-		'$ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain\n';
+		'$ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain';
 
 	static override args = {
 		key: Args.string({

src/commands/actors/call.ts

@@ -20,9 +20,8 @@ import { getLocalConfig, getLocalUserInfo, getLoggedClientOrThrow, TimestampForm
 
 export class ActorsCallCommand extends ApifyCommand<typeof ActorsCallCommand> {
 	static override 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". ' +
-		'It takes input for the Actor from the default local key-value store by default.';
+		'Executes Actor remotely using your authenticated account.\n' +
+		'Reads input from local key-value store by default.';
 
 	static override flags = {
 		...SharedRunOnCloudFlags('Actor'),
@@ -60,7 +59,7 @@ export class ActorsCallCommand extends ApifyCommand<typeof ActorsCallCommand> {
 			required: false,
 			description:
 				'Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). ' +
-				`If not provided, the command runs the remote Actor specified in the "${LOCAL_CONFIG_PATH}" file.`,
+				`If not provided, the command runs the remote Actor specified in the '${LOCAL_CONFIG_PATH}' file.`,
 		}),
 	};
 

src/commands/actors/index.ts

@@ -1,7 +1,7 @@
 import { ApifyCommand } from '../../lib/apify_command.js';
 
 export class ActorIndexCommand extends ApifyCommand<typeof ActorIndexCommand> {
-	static override description = 'Commands are designed to be used with Actors.';
+	static override description = 'Manages Actor creation, deployment, and execution on the Apify platform.';
 
 	async run() {
 		await this.printHelp();

src/commands/actors/ls.ts

@@ -93,7 +93,7 @@ interface HydratedListData {
 }
 
 export class ActorsLsCommand extends ApifyCommand<typeof ActorsLsCommand> {
-	static override description = 'Lists all recently ran Actors or your own Actors.';
+	static override description = 'Prints a list of recently executed Actors or Actors you own.';
 
 	static override flags = {
 		my: Flags.boolean({

src/commands/actors/pull.ts

@@ -24,8 +24,8 @@ const extractGitHubZip = async (url: string, directoryPath: string) => {
 
 export class ActorsPullCommand extends ApifyCommand<typeof ActorsPullCommand> {
 	static override description =
-		'Pulls an Actor from the Apify platform to the current directory. ' +
-		'If it is defined as Git repository, it will be cloned. If it is defined as Web IDE, it will fetch the files.';
+		'Download Actor code to current directory. ' +
+		'Clones Git repositories or fetches Actor files based on the source type.';
 
 	static override flags = {
 		version: Flags.string({

src/commands/actors/push.ts

@@ -41,23 +41,20 @@ const DEFAULT_BUILD_TAG = 'latest';
 
 export class ActorsPushCommand extends ApifyCommand<typeof ActorsPushCommand> {
 	static override description =
-		'Uploads the Actor to the Apify platform and builds it there.\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' +
-		"When there's an attempt to push files that are older than the Actor on the platform, the command will fail. Can be overwritten with --force flag.";
+		`Deploys Actor to Apify platform using settings from '${LOCAL_CONFIG_PATH}'.\n` +
+		`Files under '${MAX_MULTIFILE_BYTES / 1024 ** 2}' MB upload as "Multiple source files"; ` +
+		`larger projects upload as ZIP file.\n` +
+		`Use --force to override newer remote versions.`;
 
 	static override flags = {
 		version: Flags.string({
 			char: 'v',
-			description: `Actor version number to which the files should be pushed. By default, it is taken from the "${LOCAL_CONFIG_PATH}" 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': Flags.string({
 			char: 'b',
-			description: `Build tag to be applied to the successful Actor build. By default, it is taken from the "${LOCAL_CONFIG_PATH}" 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': Flags.string({
@@ -87,7 +84,7 @@ export class ActorsPushCommand extends ApifyCommand<typeof ActorsPushCommand> {
 			required: false,
 			description:
 				'Name or ID of the Actor to push (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). ' +
-				`If not provided, the command will create or modify the Actor with the name specified in "${LOCAL_CONFIG_PATH}" file.`,
+				`If not provided, the command will create or modify the Actor with the name specified in '${LOCAL_CONFIG_PATH}' file.`,
 		}),
 	};
 

src/commands/actors/rm.ts

@@ -7,7 +7,7 @@ import { error, info, success } from '../../lib/outputs.js';
 import { getLoggedClientOrThrow } from '../../lib/utils.js';
 
 export class ActorRmCommand extends ApifyCommand<typeof ActorRmCommand> {
-	static override description = 'Deletes an Actor.';
+	static override description = 'Permanently removes an Actor from your account.';
 
 	static override args = {
 		actorId: Args.string({

src/commands/actors/start.ts

@@ -12,9 +12,8 @@ import { getLocalConfig, getLocalUserInfo, getLoggedClientOrThrow, TimestampForm
 
 export class ActorsStartCommand extends ApifyCommand<typeof ActorsStartCommand> {
 	static override description =
-		'Runs a specific Actor remotely on the Apify cloud platform and immediately returns information about the run.\n' +
-		'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.';
+		'Starts Actor remotely and returns run details immediately.\n' +
+		'Uses authenticated account and local key-value store for input.';
 
 	static override flags = {
 		...SharedRunOnCloudFlags('Actor'),
@@ -42,7 +41,7 @@ export class ActorsStartCommand extends ApifyCommand<typeof ActorsStartCommand>
 			required: false,
 			description:
 				'Name or ID of the Actor to run (e.g. "my-actor", "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). ' +
-				`If not provided, the command runs the remote Actor specified in the "${LOCAL_CONFIG_PATH}" file.`,
+				`If not provided, the command runs the remote Actor specified in the '${LOCAL_CONFIG_PATH}' file.`,
 		}),
 	};