Allow to start chat session from the command line (#252588)

Author: bpasero

src/vs/code/electron-main/main.ts

@@ -491,22 +491,27 @@ class CodeMain {
 		// Parse arguments
 		const args = this.validatePaths(parseMainProcessArgv(process.argv));
 
-		// If we are started with --wait create a random temporary file
-		// and pass it over to the starting instance. We can use this file
-		// to wait for it to be deleted to monitor that the edited file
-		// is closed and then exit the waiting process.
-		//
-		// Note: we are not doing this if the wait marker has been already
-		// added as argument. This can happen if VS Code was started from CLI.
-
 		if (args.wait && !args.waitMarkerFilePath) {
+			// If we are started with --wait create a random temporary file
+			// and pass it over to the starting instance. We can use this file
+			// to wait for it to be deleted to monitor that the edited file
+			// is closed and then exit the waiting process.
+			//
+			// Note: we are not doing this if the wait marker has been already
+			// added as argument. This can happen if VS Code was started from CLI.
 			const waitMarkerFilePath = createWaitMarkerFileSync(args.verbose);
 			if (waitMarkerFilePath) {
 				addArg(process.argv, '--waitMarkerFilePath', waitMarkerFilePath);
 				args.waitMarkerFilePath = waitMarkerFilePath;
 			}
 		}
 
+		if (args.chat) {
+			// If we are started with chat subcommand, the current working
+			// directory is always the path to open
+			args._ = [cwd()];
+		}
+
 		return args;
 	}
 

src/vs/code/node/cli.ts

@@ -15,7 +15,7 @@ import { whenDeleted, writeFileSync } from '../../base/node/pfs.js';
 import { findFreePort } from '../../base/node/ports.js';
 import { watchFileContents } from '../../platform/files/node/watcher/nodejs/nodejsWatcherLib.js';
 import { NativeParsedArgs } from '../../platform/environment/common/argv.js';
-import { buildHelpMessage, buildVersionMessage, NATIVE_CLI_COMMANDS, OPTIONS } from '../../platform/environment/node/argv.js';
+import { buildHelpMessage, buildStdinMessage, buildVersionMessage, NATIVE_CLI_COMMANDS, OPTIONS } from '../../platform/environment/node/argv.js';
 import { addArg, parseCLIProcessArgv } from '../../platform/environment/node/argvHelper.js';
 import { getStdinFilePath, hasStdinWithoutTty, readFromStdin, stdinDataListener } from '../../platform/environment/node/stdin.js';
 import { createWaitMarkerFileSync } from '../../platform/environment/node/wait.js';
@@ -88,12 +88,18 @@ export async function main(argv: string[]): Promise<any> {
 		}
 	}
 
-	// Help
+	// Help (general)
 	if (args.help) {
 		const executable = `${product.applicationName}${isWindows ? '.exe' : ''}`;
 		console.log(buildHelpMessage(product.nameLong, executable, product.version, OPTIONS));
 	}
 
+	// Help (chat)
+	else if (args.chat?.help) {
+		const executable = `${product.applicationName}${isWindows ? '.exe' : ''}`;
+		console.log(buildHelpMessage(product.nameLong, executable, product.version, OPTIONS.chat.options, { isChat: true }));
+	}
+
 	// Version Info
 	else if (args.version) {
 		console.log(buildVersionMessage(product.version, product.commit));
@@ -236,7 +242,7 @@ export async function main(argv: string[]): Promise<any> {
 			});
 		}
 
-		const hasReadStdinArg = args._.some(arg => arg === '-');
+		const hasReadStdinArg = args._.some(arg => arg === '-') || args.chat?._.some(arg => arg === '-');
 		if (hasReadStdinArg) {
 			// remove the "-" argument when we read from stdin
 			args._ = args._.filter(a => a !== '-');
@@ -275,9 +281,15 @@ export async function main(argv: string[]): Promise<any> {
 						processCallbacks.push(() => readFromStdinDone.p);
 					}
 
-					// Make sure to open tmp file as editor but ignore it in the "recently open" list
-					addArg(argv, stdinFilePath);
-					addArg(argv, '--skip-add-to-recently-opened');
+					if (args.chat) {
+						// Make sure to add tmp file as context to chat
+						addArg(argv, '--add-file', stdinFilePath);
+					} else {
+						// Make sure to open tmp file as editor but ignore
+						// it in the "recently open" list
+						addArg(argv, stdinFilePath);
+						addArg(argv, '--skip-add-to-recently-opened');
+					}
 
 					console.log(`Reading from stdin via: ${stdinFilePath}`);
 				} catch (e) {
@@ -290,11 +302,7 @@ export async function main(argv: string[]): Promise<any> {
 				// if we detect that data flows into via stdin after a certain timeout.
 				processCallbacks.push(_ => stdinDataListener(1000).then(dataReceived => {
 					if (dataReceived) {
-						if (isWindows) {
-							console.log(`Run with '${product.applicationName} -' to read output from another program (e.g. 'echo Hello World | ${product.applicationName} -').`);
-						} else {
-							console.log(`Run with '${product.applicationName} -' to read from stdin (e.g. 'ps aux | grep code | ${product.applicationName} -').`);
-						}
+						console.log(buildStdinMessage(product.applicationName, !!args.chat));
 					}
 				}));
 			}

src/vs/platform/environment/common/argv.ts

@@ -13,6 +13,7 @@ export interface INativeCliOptions {
  * A list of command line arguments we support natively.
  */
 export interface NativeParsedArgs {
+
 	// subcommands
 	tunnel?: INativeCliOptions & {
 		user: {
@@ -23,6 +24,14 @@ export interface NativeParsedArgs {
 		};
 	};
 	'serve-web'?: INativeCliOptions;
+	chat?: {
+		_: string[];
+		'add-file'?: string[];
+		mode?: string;
+		help?: boolean;
+	};
+
+	// arguments
 	_: string[];
 	'folder-uri'?: string[]; // undefined or array of 1 or more
 	'file-uri'?: string[]; // undefined or array of 1 or more

src/vs/platform/environment/node/argv.ts

@@ -50,7 +50,7 @@ export const NATIVE_CLI_COMMANDS = ['tunnel', 'serve-web'] as const;
 export const OPTIONS: OptionDescriptions<Required<NativeParsedArgs>> = {
 	'tunnel': {
 		type: 'subcommand',
-		description: 'Make the current machine accessible from vscode.dev or other machines through a secure tunnel',
+		description: 'Make the current machine accessible from vscode.dev or other machines through a secure tunnel.',
 		options: {
 			'cli-data-dir': { type: 'string', args: 'dir', description: localize('cliDataDir', "Directory where CLI metadata should be stored.") },
 			'disable-telemetry': { type: 'boolean' },
@@ -78,6 +78,16 @@ export const OPTIONS: OptionDescriptions<Required<NativeParsedArgs>> = {
 			'telemetry-level': { type: 'string' },
 		}
 	},
+	'chat': {
+		type: 'subcommand',
+		description: 'Pass in a prompt to run in a chat session in the current working directory.',
+		options: {
+			'_': { type: 'string[]', description: localize('prompt', "The prompt to use as chat.") },
+			'mode': { type: 'string', cat: 'o', alias: 'm', args: 'agent|ask|edit', description: localize('chatMode', "The mode to use for the chat session. Defaults to 'agent'.") },
+			'add-file': { type: 'string[]', cat: 'o', alias: 'a', description: localize('addFile', "Add files as context to the chat session.") },
+			'help': { type: 'boolean', cat: 'o', alias: 'h', description: localize('help', "Print usage.") }
+		}
+	},
 
 	'diff': { type: 'boolean', cat: 'o', alias: 'd', args: ['file', 'file'], description: localize('diff', "Compare two files with each other.") },
 	'merge': { type: 'boolean', cat: 'o', alias: 'm', args: ['path1', 'path2', 'base', 'result'], description: localize('merge', "Perform a three-way merge by providing paths for two modified versions of a file, the common origin of both modified versions and the output file to save merge results.") },
@@ -428,20 +438,16 @@ function wrapText(text: string, columns: number): string[] {
 	return lines;
 }
 
-export function buildHelpMessage(productName: string, executableName: string, version: string, options: OptionDescriptions<any>, capabilities?: { noPipe?: boolean; noInputFiles: boolean }): string {
+export function buildHelpMessage(productName: string, executableName: string, version: string, options: OptionDescriptions<any>, capabilities?: { noPipe?: boolean; noInputFiles?: boolean; isChat?: boolean }): string {
 	const columns = (process.stdout).isTTY && (process.stdout).columns || 80;
-	const inputFiles = capabilities?.noInputFiles !== true ? `[${localize('paths', 'paths')}...]` : '';
+	const inputFiles = capabilities?.noInputFiles ? '' : capabilities?.isChat ? ` [${localize('cliPrompt', 'prompt')}]` : ` [${localize('paths', 'paths')}...]`;
 
 	const help = [`${productName} ${version}`];
 	help.push('');
 	help.push(`${localize('usage', "Usage")}: ${executableName} [${localize('options', "options")}]${inputFiles}`);
 	help.push('');
 	if (capabilities?.noPipe !== true) {
-		if (isWindows) {
-			help.push(localize('stdinWindows', "To read output from another program, append '-' (e.g. 'echo Hello World | {0} -')", executableName));
-		} else {
-			help.push(localize('stdinUnix', "To read from stdin, append '-' (e.g. 'ps aux | grep code | {0} -')", executableName));
-		}
+		help.push(buildStdinMessage(executableName, capabilities?.isChat));
 		help.push('');
 	}
 	const optionsByCategory: { [P in keyof typeof helpCategories]?: OptionDescriptions<any> } = {};
@@ -481,6 +487,25 @@ export function buildHelpMessage(productName: string, executableName: string, ve
 	return help.join('\n');
 }
 
+export function buildStdinMessage(executableName: string, isChat?: boolean): string {
+	let example: string;
+	if (isWindows) {
+		if (isChat) {
+			example = `echo Hello World | ${executableName} chat <prompt> -`;
+		} else {
+			example = `echo Hello World | ${executableName} -`;
+		}
+	} else {
+		if (isChat) {
+			example = `ps aux | grep code | ${executableName} chat <prompt> -`;
+		} else {
+			example = `ps aux | grep code | ${executableName} -`;
+		}
+	}
+
+	return localize('stdinUsage', "To read from stdin, append '-' (e.g. '{0}')", example);
+}
+
 export function buildVersionMessage(version: string | undefined, commit: string | undefined): string {
 	return `${version || localize('unknownVersion', "Unknown version")}\n${commit || localize('unknownCommit', "Unknown commit")}\n${process.arch}`;
 }

src/vs/platform/windows/electron-main/windowsMainService.ts

@@ -284,8 +284,11 @@ export class WindowsMainService extends Disposable implements IWindowsMainServic
 		// Bring window to front
 		window.focus();
 
-		// Handle --wait
+		// Handle `<app> --wait`
 		this.handleWaitMarkerFile(openConfig, [window]);
+
+		// Handle `<app> chat`
+		this.handleChatRequest(openConfig, [window]);
 	}
 
 	async open(openConfig: IOpenConfiguration): Promise<ICodeWindow[]> {
@@ -443,9 +446,12 @@ export class WindowsMainService extends Disposable implements IWindowsMainServic
 			this.workspacesHistoryMainService.addRecentlyOpened(recents);
 		}
 
-		// Handle --wait
+		// Handle `<app> --wait`
 		this.handleWaitMarkerFile(openConfig, usedWindows);
 
+		// Handle `<app> chat`
+		this.handleChatRequest(openConfig, usedWindows);
+
 		return usedWindows;
 	}
 
@@ -468,6 +474,27 @@ export class WindowsMainService extends Disposable implements IWindowsMainServic
 		}
 	}
 
+	private handleChatRequest(openConfig: IOpenConfiguration, usedWindows: ICodeWindow[]): void {
+		if (openConfig.context !== OpenContext.CLI || !openConfig.cli.chat || usedWindows.length === 0) {
+			return;
+		}
+
+		let windowHandlingChatRequest: ICodeWindow | undefined;
+		if (usedWindows.length === 1) {
+			windowHandlingChatRequest = usedWindows[0];
+		} else {
+			const chatRequestFolder = openConfig.cli._[0]; // chat request gets cwd() as folder to open
+			if (chatRequestFolder) {
+				windowHandlingChatRequest = findWindowOnWorkspaceOrFolder(usedWindows, URI.file(chatRequestFolder));
+			}
+		}
+
+		if (windowHandlingChatRequest) {
+			windowHandlingChatRequest.sendWhenReady('vscode:handleChatRequest', CancellationToken.None, openConfig.cli.chat);
+			windowHandlingChatRequest.focus();
+		}
+	}
+
 	private async doOpen(
 		openConfig: IOpenConfiguration,
 		workspacesToOpen: IWorkspacePathToOpen[],

src/vs/server/node/remoteExtensionHostAgentCli.ts

@@ -63,8 +63,7 @@ class CliMain extends Disposable {
 	}
 
 	private registerListeners(): void {
-		// Dispose on exit
-		process.once('exit', () => this.dispose());
+		process.once('exit', () => this.dispose()); // Dispose on exit
 	}
 
 	async run(): Promise<void> {
@@ -190,13 +189,13 @@ export async function run(args: ServerParsedArgs, REMOTE_DATA_FOLDER: string, op
 		console.log(buildHelpMessage(product.nameLong, executable, product.version, optionDescriptions, { noInputFiles: true, noPipe: true }));
 		return;
 	}
+
 	// Version Info
 	if (args.version) {
 		console.log(buildVersionMessage(product.version, product.commit));
 		return;
 	}
 
-
 	const cliMain = new CliMain(args, REMOTE_DATA_FOLDER);
 	try {
 		await cliMain.run();

src/vs/workbench/contrib/chat/browser/actions/chatActions.ts

@@ -95,6 +95,10 @@ export interface IChatViewOpenOptions {
 	 * Whether a screenshot of the focused window should be taken and attached
 	 */
 	attachScreenshot?: boolean;
+	/**
+	 * A list of file URIs to attach to the chat as context.
+	 */
+	attachFiles?: URI[];
 	/**
 	 * The mode to open the chat in.
 	 */
@@ -166,6 +170,11 @@ abstract class OpenChatGlobalAction extends Action2 {
 				chatWidget.attachmentModel.addContext(convertBufferToScreenshotVariable(screenshot));
 			}
 		}
+		if (opts?.attachFiles) {
+			for (const file of opts.attachFiles) {
+				chatWidget.attachmentModel.addFile(file);
+			}
+		}
 		if (opts?.query) {
 			if (opts.isPartialQuery) {
 				chatWidget.setInput(opts.query);

src/vs/workbench/contrib/chat/electron-browser/chat.contribution.ts

@@ -3,6 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import { localize } from '../../../../nls.js';
 import { InlineVoiceChatAction, QuickVoiceChatAction, StartVoiceChatAction, VoiceChatInChatViewAction, StopListeningAction, StopListeningAndSubmitAction, KeywordActivationContribution, InstallSpeechProviderForVoiceChatAction, HoldToVoiceChatInChatViewAction, ReadChatResponseAloud, StopReadAloud, StopReadChatItemAloud } from './actions/voiceChatActions.js';
 import { registerAction2 } from '../../../../platform/actions/common/actions.js';
 import { IWorkbenchContribution, WorkbenchPhase, registerWorkbenchContribution2 } from '../../../common/contributions.js';
@@ -11,6 +12,17 @@ import { IInstantiationService } from '../../../../platform/instantiation/common
 import { ILanguageModelToolsService } from '../common/languageModelToolsService.js';
 import { FetchWebPageTool, FetchWebPageToolData } from './tools/fetchPageTool.js';
 import { registerChatDeveloperActions } from './actions/chatDeveloperActions.js';
+import { INativeWorkbenchEnvironmentService } from '../../../services/environment/electron-browser/environmentService.js';
+import { ICommandService } from '../../../../platform/commands/common/commands.js';
+import { ACTION_ID_NEW_CHAT, CHAT_OPEN_ACTION_ID, IChatViewOpenOptions } from '../browser/actions/chatActions.js';
+import { ChatModeKind, validateChatMode } from '../common/constants.js';
+import { ipcRenderer } from '../../../../base/parts/sandbox/electron-browser/globals.js';
+import { IWorkspaceTrustRequestService } from '../../../../platform/workspace/common/workspaceTrust.js';
+import { URI } from '../../../../base/common/uri.js';
+import { resolve } from '../../../../base/common/path.js';
+import { showChatView } from '../browser/chat.js';
+import { IViewsService } from '../../../services/views/common/viewsService.js';
+import { ILogService } from '../../../../platform/log/common/log.js';
 
 class NativeBuiltinToolsContribution extends Disposable implements IWorkbenchContribution {
 
@@ -28,6 +40,56 @@ class NativeBuiltinToolsContribution extends Disposable implements IWorkbenchCon
 	}
 }
 
+class ChatCommandLineHandler extends Disposable {
+
+	static readonly ID = 'workbench.contrib.chatCommandLineHandler';
+
+	constructor(
+		@INativeWorkbenchEnvironmentService private readonly environmentService: INativeWorkbenchEnvironmentService,
+		@ICommandService private readonly commandService: ICommandService,
+		@IWorkspaceTrustRequestService private readonly workspaceTrustRequestService: IWorkspaceTrustRequestService,
+		@IViewsService private readonly viewsService: IViewsService,
+		@ILogService private readonly logService: ILogService
+	) {
+		super();
+
+		this.registerListeners();
+	}
+
+	private registerListeners() {
+		ipcRenderer.on('vscode:handleChatRequest', (_, args: typeof this.environmentService.args.chat) => {
+			this.logService.trace('vscode:handleChatRequest', args);
+
+			this.prompt(args);
+		});
+	}
+
+	private async prompt(args: typeof this.environmentService.args.chat): Promise<void> {
+		if (!Array.isArray(args?._)) {
+			return;
+		}
+
+		const trusted = await this.workspaceTrustRequestService.requestWorkspaceTrust({
+			message: localize('copilotWorkspaceTrust', "Copilot is currently only supported in trusted workspaces.")
+		});
+
+		if (!trusted) {
+			return;
+		}
+
+		const opts: IChatViewOpenOptions = {
+			query: args._.length > 0 ? args._.join(' ') : '',
+			mode: validateChatMode(args.mode) ?? ChatModeKind.Agent,
+			attachFiles: args['add-file']?.map(file => URI.file(resolve(file))), // use `resolve` to deal with relative paths properly
+		};
+
+		const chatWidget = await showChatView(this.viewsService);
+		await chatWidget?.waitForReady();
+		await this.commandService.executeCommand(ACTION_ID_NEW_CHAT);
+		await this.commandService.executeCommand(CHAT_OPEN_ACTION_ID, opts);
+	}
+}
+
 registerAction2(StartVoiceChatAction);
 registerAction2(InstallSpeechProviderForVoiceChatAction);
 
@@ -47,3 +109,4 @@ registerChatDeveloperActions();
 
 registerWorkbenchContribution2(KeywordActivationContribution.ID, KeywordActivationContribution, WorkbenchPhase.AfterRestored);
 registerWorkbenchContribution2(NativeBuiltinToolsContribution.ID, NativeBuiltinToolsContribution, WorkbenchPhase.AfterRestored);
+registerWorkbenchContribution2(ChatCommandLineHandler.ID, ChatCommandLineHandler, WorkbenchPhase.BlockRestore);