Skip to content

Commit befcca7

Browse files
committed
Update the docs for the Recorder
1 parent e28a958 commit befcca7

File tree

4 files changed

+5
-1
lines changed

4 files changed

+5
-1
lines changed

help_docs/recorder_mode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
sbase mkrec TEST_NAME.py --url=URL
1515
```
1616

17-
If the file already exists, you'll get an error. If no URL is provided, you'll start on a blank page and will need to navigate somewhere for the Recorder to activate. (The Recorder captures events on URLs that start with ``https``, ``http``, or ``file``.) The command above runs an empty test that stops at a breakpoint so that you can perform manual browser actions for the Recorder. When you have finished recording, type "``c``" on the command-line and press ``[ENTER]`` to let the test continue from the breakpoint. The test will then complete and a file called ``TEST_NAME_rec.py`` will be automatically created in the ``./recordings`` folder. That file will get copied back to the original folder with the name you gave it. (You can run with Edge instead of Chrome by adding ``--edge`` to the command above.)
17+
If the file already exists, you'll get an error. If no URL is provided, you'll start on a blank page and will need to navigate somewhere for the Recorder to activate. (The Recorder captures events on URLs that start with ``https``, ``http``, or ``file``.) The command above runs an empty test that stops at a breakpoint so that you can perform manual browser actions for the Recorder. When you have finished recording, type "``c``" on the command-line and press ``[ENTER]`` to let the test continue from the breakpoint. The test will then complete and a file called ``TEST_NAME_rec.py`` will be automatically created in the ``./recordings`` folder. That file will get copied back to the original folder with the name you gave it. (You can run with Edge instead of Chrome by adding ``--edge`` to the command above. For headed Linux machines, add ``--gui`` to prevent the default headless mode on Linux.)
1818

1919
Example:
2020

seleniumbase/console_scripts/ReadMe.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ is included.
237237
* Options:
238238
``--url=URL`` (Sets the initial start page URL.)
239239
``--edge`` (Use Edge browser instead of Chrome.)
240+
``--gui`` / ``--headed`` (Use headed mode on Linux.)
240241

241242
* Output:
242243
Creates a new SeleniumBase test using the Recorder.

seleniumbase/console_scripts/run.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ def show_mkrec_usage():
213213
print(" Options:")
214214
print(" --url=URL (Sets the initial start page URL.)")
215215
print(" --edge (Use Edge browser instead of Chrome.)")
216+
print(" --gui / --headed (Use headed mode on Linux.)")
216217
print(" Output:")
217218
print(" Creates a new SeleniumBase test using the Recorder.")
218219
print(" If the filename already exists, an error is raised.")
@@ -235,6 +236,7 @@ def show_codegen_usage():
235236
print(" Options:")
236237
print(" --url=URL (Sets the initial start page URL.)")
237238
print(" --edge (Use Edge browser instead of Chrome.)")
239+
print(" --gui / --headed (Use headed mode on Linux.)")
238240
print(" Output:")
239241
print(" Creates a new SeleniumBase test using the Recorder.")
240242
print(" If the filename already exists, an error is raised.")

seleniumbase/console_scripts/sb_mkrec.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
Options:
1818
--url=URL (Sets the initial start page URL.)
1919
--edge (Use Edge browser instead of Chrome.)
20+
--gui / --headed (Use headed mode on Linux.)
2021
2122
Output:
2223
Creates a new SeleniumBase test using the Recorder.

0 commit comments

Comments
 (0)