1# Running Custom Playwright Code
2 
3Use `run-code` to execute arbitrary Playwright code for advanced scenarios not covered by CLI commands.
4 
5## Syntax
6 
7```bash
8playwright-cli run-code "async page => {
9  // Your Playwright code here
10  // Access page.context() for browser context operations
11}"
12```
13 
14You can also load the function from a file:
15 
16```bash
17playwright-cli run-code --filename=./my-script.js
18```
19 
20 
21The code must be a single function expression, it is wrapped in `(...)` and evaluated.
22import/export/require syntax is not supported.
23 
24## Geolocation
25 
26```bash
27# Grant geolocation permission and set location
28playwright-cli run-code "async page => {
29  await page.context().grantPermissions(['geolocation']);
30  await page.context().setGeolocation({ latitude: 37.7749, longitude: -122.4194 });
31}"
32 
33# Set location to London
34playwright-cli run-code "async page => {
35  await page.context().grantPermissions(['geolocation']);
36  await page.context().setGeolocation({ latitude: 51.5074, longitude: -0.1278 });
37}"
38 
39# Clear geolocation override
40playwright-cli run-code "async page => {
41  await page.context().clearPermissions();
42}"
43```
44 
45## Permissions
46 
47```bash
48# Grant multiple permissions
49playwright-cli run-code "async page => {
50  await page.context().grantPermissions([
51    'geolocation',
52    'notifications',
53    'camera',
54    'microphone'
55  ]);
56}"
57 
58# Grant permissions for specific origin
59playwright-cli run-code "async page => {
60  await page.context().grantPermissions(['clipboard-read'], {
61    origin: 'https://example.com'
62  });
63}"
64```
65 
66## Media Emulation
67 
68```bash
69# Emulate dark color scheme
70playwright-cli run-code "async page => {
71  await page.emulateMedia({ colorScheme: 'dark' });
72}"
73 
74# Emulate light color scheme
75playwright-cli run-code "async page => {
76  await page.emulateMedia({ colorScheme: 'light' });
77}"
78 
79# Emulate reduced motion
80playwright-cli run-code "async page => {
81  await page.emulateMedia({ reducedMotion: 'reduce' });
82}"
83 
84# Emulate print media
85playwright-cli run-code "async page => {
86  await page.emulateMedia({ media: 'print' });
87}"
88```
89 
90## Wait Strategies
91 
92```bash
93# Wait for network idle
94playwright-cli run-code "async page => {
95  await page.waitForLoadState('networkidle');
96}"
97 
98# Wait for specific element
99playwright-cli run-code "async page => {
100  await page.locator('.loading').waitFor({ state: 'hidden' });
101}"
102 
103# Wait for function to return true
104playwright-cli run-code "async page => {
105  await page.waitForFunction(() => window.appReady === true);
106}"
107 
108# Wait with timeout
109playwright-cli run-code "async page => {
110  await page.locator('.result').waitFor({ timeout: 10000 });
111}"
112```
113 
114## Frames and Iframes
115 
116```bash
117# Work with iframe
118playwright-cli run-code "async page => {
119  const frame = page.locator('iframe#my-iframe').contentFrame();
120  await frame.locator('button').click();
121}"
122 
123# Get all frames
124playwright-cli run-code "async page => {
125  const frames = page.frames();
126  return frames.map(f => f.url());
127}"
128```
129 
130## File Downloads
131 
132```bash
133# Handle file download
134playwright-cli run-code "async page => {
135  const downloadPromise = page.waitForEvent('download');
136  await page.getByRole('link', { name: 'Download' }).click();
137  const download = await downloadPromise;
138  await download.saveAs('./downloaded-file.pdf');
139  return download.suggestedFilename();
140}"
141```
142 
143## Clipboard
144 
145```bash
146# Read clipboard (requires permission)
147playwright-cli run-code "async page => {
148  await page.context().grantPermissions(['clipboard-read']);
149  return await page.evaluate(() => navigator.clipboard.readText());
150}"
151 
152# Write to clipboard
153playwright-cli run-code "async page => {
154  await page.evaluate(text => navigator.clipboard.writeText(text), 'Hello clipboard!');
155}"
156```
157 
158## Page Information
159 
160```bash
161# Get page title
162playwright-cli run-code "async page => {
163  return await page.title();
164}"
165 
166# Get current URL
167playwright-cli run-code "async page => {
168  return page.url();
169}"
170 
171# Get page content
172playwright-cli run-code "async page => {
173  return await page.content();
174}"
175 
176# Get viewport size
177playwright-cli run-code "async page => {
178  return page.viewportSize();
179}"
180```
181 
182## JavaScript Execution
183 
184```bash
185# Execute JavaScript and return result
186playwright-cli run-code "async page => {
187  return await page.evaluate(() => {
188    return {
189      userAgent: navigator.userAgent,
190      language: navigator.language,
191      cookiesEnabled: navigator.cookieEnabled
192    };
193  });
194}"
195 
196# Pass arguments to evaluate
197playwright-cli run-code "async page => {
198  const multiplier = 5;
199  return await page.evaluate(m => document.querySelectorAll('li').length * m, multiplier);
200}"
201```
202 
203## Error Handling
204 
205```bash
206# Try-catch in run-code
207playwright-cli run-code "async page => {
208  try {
209    await page.getByRole('button', { name: 'Submit' }).click({ timeout: 1000 });
210    return 'clicked';
211  } catch (e) {
212    return 'element not found';
213  }
214}"
215```
216 
217## Complex Workflows
218 
219```bash
220# Login and save state
221playwright-cli run-code "async page => {
222  await page.goto('https://example.com/login');
223  await page.getByRole('textbox', { name: 'Email' }).fill('[email protected]');
224  await page.getByRole('textbox', { name: 'Password' }).fill('secret');
225  await page.getByRole('button', { name: 'Sign in' }).click();
226  await page.waitForURL('**/dashboard');
227  await page.context().storageState({ path: 'auth.json' });
228  return 'Login successful';
229}"
230 
231# Scrape data from multiple pages
232playwright-cli run-code "async page => {
233  const results = [];
234  for (let i = 1; i <= 3; i++) {
235    await page.goto(\`https://example.com/page/\${i}\`);
236    const items = await page.locator('.item').allTextContents();
237    results.push(...items);
238  }
239  return results;
240}"
241```
242