feat: add --profile, auth switch, auth list and per-account logout

scripts/generate-cli-docs.ts

@@ -11,6 +11,8 @@ const categories: Record<string, CommandsInCategory[]> = {
 		{ command: Commands.auth },
 		{ command: Commands.authLogin, aliases: [Commands.login] },
 		{ command: Commands.authLogout, aliases: [Commands.logout] },
+		{ command: Commands.authList },
+		{ command: Commands.authSwitch },
 		{ command: Commands.authToken },
 		{ command: Commands.info },
 		{ command: Commands.secrets },

src/commands/actors/call.ts

@@ -25,6 +25,8 @@ import { getLocalConfig, getCurrentUserInfo, getLoggedClientOrThrow, TimestampFo
 export class ActorsCallCommand extends ApifyCommand<typeof ActorsCallCommand> {
 	static override name = 'call' as const;
 
+	static override enableProfileFlag = true;
+
 	static override description =
 		'Executes Actor remotely using your authenticated account.\n' +
 		'Reads input from local key-value store by default.\n' +

src/commands/actors/info.ts

@@ -45,6 +45,8 @@ const payPerEventTable = new ResponsiveTable({
 export class ActorsInfoCommand extends ApifyCommand<typeof ActorsInfoCommand> {
 	static override name = 'info' as const;
 
+	static override enableProfileFlag = true;
+
 	static override description = 'Get information about an Actor.';
 
 	static override examples = [

src/commands/actors/ls.ts

@@ -97,6 +97,8 @@ interface HydratedListData {
 export class ActorsLsCommand extends ApifyCommand<typeof ActorsLsCommand> {
 	static override name = 'ls' as const;
 
+	static override enableProfileFlag = true;
+
 	static override description = 'Prints a list of recently executed Actors or Actors you own.';
 
 	static override examples = [

src/commands/actors/pull.ts

@@ -23,6 +23,8 @@ const extractGitHubZip = async (url: string, directoryPath: string) => {
 export class ActorsPullCommand extends ApifyCommand<typeof ActorsPullCommand> {
 	static override name = 'pull' as const;
 
+	static override enableProfileFlag = true;
+
 	static override description =
 		'Download Actor code to current directory. ' +
 		'Clones Git repositories or fetches Actor files based on the source type.';

src/commands/actors/push.ts

@@ -156,6 +156,8 @@ const confirmGitSourceSwitch = async ({
 export class ActorsPushCommand extends ApifyCommand<typeof ActorsPushCommand> {
 	static override name = 'push' as const;
 
+	static override enableProfileFlag = true;
+
 	static override description =
 		`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"; ` +

src/commands/actors/rm.ts

@@ -10,6 +10,8 @@ import { getLoggedClientOrThrow } from '../../lib/utils.js';
 export class ActorsRmCommand extends ApifyCommand<typeof ActorsRmCommand> {
 	static override name = 'rm' as const;
 
+	static override enableProfileFlag = true;
+
 	static override description = 'Permanently removes an Actor from your account.';
 
 	static override interactive = true;

src/commands/actors/start.ts

@@ -18,6 +18,8 @@ import { ActorsCallCommand } from './call.js';
 export class ActorsStartCommand extends ApifyCommand<typeof ActorsStartCommand> {
 	static override name = 'start' as const;
 
+	static override enableProfileFlag = true;
+
 	static override description =
 		'Starts Actor remotely and returns run details immediately.\n' +
 		'Uses authenticated account and local key-value store for input.';

src/commands/api.ts

@@ -140,6 +140,8 @@ export class ApiCommand extends ApifyCommand<typeof ApiCommand> {
 
 	static override name = 'api' as const;
 
+	static override enableProfileFlag = true;
+
 	static override description =
 		'Makes an authenticated HTTP request to the Apify API and prints the response.\n' +
 		'The endpoint can be a relative path (e.g. "acts", "v2/acts", or "/v2/acts"); ' +

src/commands/auth/_index.ts

@@ -1,19 +1,27 @@
 import { ApifyCommand } from '../../lib/command-framework/apify-command.js';
+import { AuthListCommand } from './list.js';
 import { AuthLoginCommand } from './login.js';
 import { AuthLogoutCommand } from './logout.js';
+import { AuthSwitchCommand } from './switch.js';
 import { AuthTokenCommand } from './token.js';
 
 export class AuthIndexCommand extends ApifyCommand<typeof AuthIndexCommand> {
 	static override name = 'auth' as const;
 
 	static override description =
-		'Log in, log out, and inspect your stored Apify API token. Also available as `apify login` / `apify logout`.';
+		'Log in, log out, switch between stored accounts, and inspect your stored Apify API token. Also available as `apify login` / `apify logout`.';
 
 	static override group = 'Authentication';
 
 	static override docsUrl = 'https://docs.apify.com/cli/docs/reference#apify-auth';
 
-	static override subcommands = [AuthLoginCommand, AuthLogoutCommand, AuthTokenCommand];
+	static override subcommands = [
+		AuthLoginCommand,
+		AuthLogoutCommand,
+		AuthListCommand,
+		AuthSwitchCommand,
+		AuthTokenCommand,
+	];
 
 	async run() {
 		this.printHelp();

src/commands/auth/list.ts

@@ -0,0 +1,110 @@
+import chalk from 'chalk';
+
+import { APIFY_ENV_VARS } from '@apify/consts';
+
+import {
+	assertSupportedAuthFileVersion,
+	getActiveProfileId,
+	listProfiles,
+	profileLabel,
+	readAuthFile,
+} from '../../lib/auth-file.js';
+import { invalidEnvTokenMessage, NO_STORED_ACCOUNTS_MESSAGE, readEnvToken } from '../../lib/auth.js';
+import { ApifyCommand } from '../../lib/command-framework/apify-command.js';
+import { CompactMode, ResponsiveTable } from '../../lib/commands/responsive-table.js';
+import { getBackend } from '../../lib/credentials.js';
+import { simpleLog, warning } from '../../lib/outputs.js';
+import { printJsonToStdout, TimestampFormatter } from '../../lib/utils.js';
+
+const STORAGE_LABELS = { keyring: 'OS keyring', file: 'auth.json', none: chalk.gray('None') };
+
+const table = new ResponsiveTable({
+	allColumns: ['Name', 'User ID', 'Type', 'Last login', 'Storage'],
+	mandatoryColumns: ['Name', 'User ID'],
+});
+
+export class AuthListCommand extends ApifyCommand<typeof AuthListCommand> {
+	static override name = 'list' as const;
+
+	static override aliases = ['ls'];
+
+	static override description =
+		'Lists the stored Apify accounts and marks the active one. Reads only the local login, so it works offline and does not check that the tokens are still valid.';
+
+	static override enableJsonFlag = true;
+
+	static override group = 'Authentication';
+
+	static override examples = [
+		{
+			description: 'List the stored accounts.',
+			command: 'apify auth list',
+		},
+		{
+			description: 'List the stored accounts as JSON, for scripts.',
+			command: 'apify auth list --json',
+		},
+	];
+
+	static override docsUrl = 'https://docs.apify.com/cli/docs/reference#apify-auth-list';
+
+	async run() {
+		// No credential migration: it reads the OS keyring, and listing must not prompt for it.
+		assertSupportedAuthFileVersion();
+
+		const file = readAuthFile();
+		const activeId = getActiveProfileId();
+		const envToken = readEnvToken();
+		// Loads the keyring module without reading from it, so listing never prompts for the keychain.
+		const keyringBackend = await getBackend();
+
+		const profiles = listProfiles().map((profile) => ({
+			id: profile.id,
+			name: profileLabel(profile),
+			username: profile.username ?? null,
+			active: profile.id === activeId,
+			isOrganization: Boolean(profile.organizationOwnerUserId),
+			organizationOwnerUserId: profile.organizationOwnerUserId ?? null,
+			loggedInAt: profile.loggedInAt,
+			// Same rule as `backendFor`: a token in the file wins, and without the keyring nothing else holds one.
+			secretsBackend:
+				(profile.token ?? (profile.id === activeId ? file.token : undefined)) !== undefined
+					? ('file' as const)
+					: keyringBackend === 'keyring'
+						? keyringBackend
+						: null,
+		}));
+
+		if (this.flags.json) {
+			printJsonToStdout({ envTokenInUse: envToken.kind !== 'unset', profiles });
+			return;
+		}
+
+		if (envToken.kind === 'token') {
+			warning({
+				message: `${APIFY_ENV_VARS.TOKEN} is set, so commands use it instead of the active account.`,
+			});
+		} else if (envToken.kind === 'invalid') {
+			warning({ message: invalidEnvTokenMessage(envToken.raw) });
+		}
+
+		if (!profiles.length) {
+			simpleLog({ message: NO_STORED_ACCOUNTS_MESSAGE, stdout: true });
+			return;
+		}
+
+		for (const profile of profiles) {
+			table.pushRow({
+				Name: profile.active ? `${chalk.bold(profile.name)} ${chalk.green('(active)')}` : profile.name,
+				'User ID': chalk.gray(profile.id),
+				Type: profile.isOrganization ? 'Organization' : 'Personal',
+				'Last login': profile.loggedInAt
+					? TimestampFormatter.display(new Date(profile.loggedInAt))
+					: chalk.gray('Unknown'),
+				Storage: STORAGE_LABELS[profile.secretsBackend ?? 'none'],
+			});
+		}
+
+		simpleLog({ message: table.render(CompactMode.WebLikeCompact), stdout: true });
+	}
+}