Skip to content

fix(cli): improve error messages to guide AI agents and developers #2161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yasirusman85 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(cli): improve error messages to guide AI agents and developers #2161

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion src/bin/chrome-devtools.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,43 @@ const y = yargs(hideBin(process.argv))
.version(VERSION)
.strict()
.help(true)
.wrap(120);
.wrap(120)
.fail((msg, err) => {
if (msg) {
console.error('Error:', msg);
if (
msg.includes('Not enough non-option arguments') ||
msg.includes('Unknown argument') ||
msg.includes('Unknown arguments')
) {
console.error('\n=========================================');
console.error('💡 TIP FOR AI AGENT / DEVELOPER:');
console.error('In the `chrome-devtools` CLI:');
console.error(
'1. Required parameters MUST be passed as positional arguments (without flags).',
);
console.error(
' - INCORRECT: chrome-devtools evaluate_script --expression "() => document.title"',
);
console.error(
' - CORRECT: chrome-devtools evaluate_script "() => document.title"',
);
console.error(
'2. Optional parameters are passed as double-dash options/flags (e.g. --pageId 1).',
);
console.error(
'3. Make sure to escape quotes properly for your shell environment.',
);
console.error(
'Run `chrome-devtools <command> --help` to see exact positional and optional parameters.',
);
console.error('=========================================');
}
} else if (err) {
console.error(err);
}
process.exit(1);
});

y.command(
'start',
Expand Down
Loading