Skip to content

Commit 9babc67

Browse files
committed
Update a ReadMe
1 parent 3488166 commit 9babc67

File tree

1 file changed

+40
-31
lines changed

1 file changed

+40
-31
lines changed

seleniumbase/console_scripts/ReadMe.md

Lines changed: 40 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ COMMANDS:
4848
Use "pytest" for running tests.
4949
```
5050

51-
<h3>get / install</h3>
51+
<h3><code>get</code> / <code>install</code></h3>
5252

5353
* Usage:
5454

@@ -73,12 +73,21 @@ sbase get cft 131
7373
sbase get chs
7474
```
7575

76-
(Drivers: `chromedriver`, `cft`, `uc_driver`,
77-
`edgedriver`, `chs`, `geckodriver`)
76+
* Drivers:
7877

79-
(Options: A specific driver version or major version integer.
80-
If not set, the driver version matches the browser.
81-
`-p` / `--path`: Also copy to "/usr/local/bin".)
78+
```zsh
79+
`chromedriver` , `cft`, `uc_driver`
80+
`edgedriver` , `chs` , `geckodriver`
81+
```
82+
83+
* Options:
84+
85+
```zsh
86+
NUM: A specific driver version or major version integer.
87+
If not set, the driver version matches the browser.
88+
89+
`-p` / `--path`: Also copy the driver to /usr/local/bin.
90+
```
8291

8392
* Output:
8493

@@ -88,7 +97,7 @@ Downloads the webdriver to `seleniumbase/drivers/`
8897
(`geckodriver` is required for Firefox automation)<br />
8998
(`edgedriver` is required for Edge automation)
9099

91-
<h3>methods</h3>
100+
<h3><code>methods</code></h3>
92101

93102
* Usage:
94103

@@ -100,7 +109,7 @@ sbase methods
100109

101110
Displays common SeleniumBase Python methods.
102111

103-
<h3>options</h3>
112+
<h3><code>options</code></h3>
104113

105114
* Usage:
106115

@@ -167,7 +176,7 @@ that are available when using SeleniumBase.
167176
For the full list of command-line options, type: "pytest --help".
168177
```
169178
170-
<h3>behave-options</h3>
179+
<h3><code>behave-options</code></h3>
171180
172181
* Usage:
173182
@@ -225,7 +234,7 @@ that are available when using SeleniumBase.
225234
For the full list of command-line options, type: "behave --help".
226235
```
227236
228-
<h3>gui / commander</h3>
237+
<h3><code>gui</code> / <code>commander</code></h3>
229238
230239
* Usage:
231240
@@ -234,7 +243,7 @@ sbase gui [OPTIONAL PATH or TEST FILE]
234243
sbase commander [OPTIONAL PATH or TEST FILE]
235244
```
236245
237-
<h3>behave-gui</h3>
246+
<h3><code>behave-gui</code></h3>
238247
239248
* Usage:
240249
@@ -256,7 +265,7 @@ sbase behave-gui features/calculator.feature
256265
257266
Launches SeleniumBase Commander / GUI for Behave.
258267
259-
<h3>caseplans</h3>
268+
<h3><code>caseplans</code></h3>
260269
261270
* Usage:
262271
@@ -278,7 +287,7 @@ sbase caseplans offline_examples/
278287
279288
Launches the SeleniumBase Case Plans Generator.
280289
281-
<h3>mkdir</h3>
290+
<h3><code>mkdir</code></h3>
282291
283292
* Usage:
284293
@@ -350,7 +359,7 @@ ui_tests/
350359
└── python-package.yml
351360
```
352361
353-
<h3>mkfile</h3>
362+
<h3><code>mkfile</code></h3>
354363
355364
* Usage:
356365
@@ -406,7 +415,7 @@ option, only the "open" method is included. Only the
406415
BaseCase format supports Languages or Recorder Mode.
407416
UC Mode automatically uses English with SB() format.
408417
409-
<h3>mkrec / record / codegen</h3>
418+
<h3><code>mkrec</code> / <code>record</code> / <code>codegen</code></h3>
410419
411420
* Usage:
412421
@@ -441,7 +450,7 @@ sbase codegen new_test.py --url=wikipedia.org
441450
Creates a new SeleniumBase test using the Recorder.
442451
If the filename already exists, an error is raised.
443452
444-
<h3>recorder</h3>
453+
<h3><code>recorder</code></h3>
445454
446455
* Usage:
447456
@@ -460,7 +469,7 @@ sbase recorder [OPTIONS]
460469
461470
Launches the SeleniumBase Recorder Desktop App.
462471
463-
<h3>mkpres</h3>
472+
<h3><code>mkpres</code></h3>
464473
465474
* Usage:
466475
@@ -492,7 +501,7 @@ By default, the slides are written in English,
492501
and use "serif" theme with "slide" transition.
493502
The slides can be used as a basic boilerplate.
494503
495-
<h3>mkchart</h3>
504+
<h3><code>mkchart</code></h3>
496505
497506
* Usage:
498507
@@ -524,7 +533,7 @@ By default, the slides are written in English,
524533
and use a "sky" theme with "slide" transition.
525534
The chart can be used as a basic boilerplate.
526535
527-
<h3>print</h3>
536+
<h3><code>print</code></h3>
528537
529538
* Usage:
530539
@@ -543,7 +552,7 @@ sbase print [FILE] [OPTIONS]
543552
Prints the code/text of any file
544553
with syntax-highlighting.
545554
546-
<h3>translate</h3>
555+
<h3><code>translate</code></h3>
547556
548557
* Usage:
549558
@@ -587,7 +596,7 @@ plus the 2-letter language code of the new language.
587596
(Example: Translating "test_1.py" into Japanese with
588597
`-c` will create a new file called "test_1_ja.py".)
589598
590-
<h3>extract-objects</h3>
599+
<h3><code>extract-objects</code></h3>
591600
592601
* Usage:
593602
@@ -601,7 +610,7 @@ Creates page objects based on selectors found in a
601610
seleniumbase Python file and saves those objects to the
602611
"page_objects.py" file in the same folder as the tests.
603612
604-
<h3>inject-objects</h3>
613+
<h3><code>inject-objects</code></h3>
605614
606615
* Usage:
607616
@@ -621,7 +630,7 @@ Takes the page objects found in the "page_objects.py"
621630
file and uses those to replace matching selectors in
622631
the selected seleniumbase Python file.
623632
624-
<h3>objectify</h3>
633+
<h3><code>objectify</code></h3>
625634
626635
* Usage:
627636
@@ -643,7 +652,7 @@ have been replaced with variable names defined in
643652
(This has the same outcome as combining
644653
`extract-objects` with `inject-objects`)
645654
646-
<h3>revert-objects</h3>
655+
<h3><code>revert-objects</code></h3>
647656
648657
* Usage:
649658
@@ -664,7 +673,7 @@ Reverts the changes made by `seleniumbase objectify ...` or
664673
seleniumbase Python file. Objects will get replaced by
665674
selectors stored in the "page_objects.py" file.
666675
667-
<h3>convert</h3>
676+
<h3><code>convert</code></h3>
668677
669678
* Usage:
670679
@@ -679,7 +688,7 @@ file into a SeleniumBase file. Adds `_SB` to the
679688
new filename while keeping the original file intact.
680689
Works on both Selenium IDE & Katalon Recorder scripts.
681690
682-
<h3>encrypt / obfuscate</h3>
691+
<h3><code>encrypt</code> / <code>obfuscate</code></h3>
683692
684693
* Usage:
685694
@@ -690,7 +699,7 @@ Works on both Selenium IDE & Katalon Recorder scripts.
690699
Runs the password encryption/obfuscation tool.
691700
(Where you can enter a password to encrypt/obfuscate.)
692701
693-
<h3>decrypt / unobfuscate</h3>
702+
<h3><code>decrypt</code> / <code>unobfuscate</code></h3>
694703
695704
* Usage:
696705
@@ -701,7 +710,7 @@ Runs the password encryption/obfuscation tool.
701710
Runs the password decryption/unobfuscation tool.
702711
(Where you can enter an encrypted password to decrypt.)
703712
704-
<h3>proxy</h3>
713+
<h3><code>proxy</code></h3>
705714
706715
* Usage:
707716
@@ -722,7 +731,7 @@ sbase proxy [OPTIONS]
722731
Launch a basic proxy server on the current machine.
723732
(Uses `127.0.0.1:8899` as the default address.)
724733
725-
<h3>download</h3>
734+
<h3><code>download</code></h3>
726735
727736
* Usage:
728737
@@ -735,7 +744,7 @@ sbase download server
735744
Downloads the Selenium Server JAR file for Grid usage.
736745
(That JAR file is required when using a Selenium Grid)
737746
738-
<h3>grid-hub</h3>
747+
<h3><code>grid-hub</code></h3>
739748
740749
* Usage:
741750
@@ -758,7 +767,7 @@ to speed up test runs and reduce the total time
758767
of test suite execution.
759768
You can start, restart, or stop the Grid Hub server.
760769
761-
<h3>grid-node</h3>
770+
<h3><code>grid-node</code></h3>
762771
763772
* Usage:
764773

0 commit comments

Comments
 (0)