Skip to content
This repository was archived by the owner on Sep 20, 2022. It is now read-only.

docs: actualize #89

Open
eGavr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: actualize #89

Show file tree
Hide file tree
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
28 changes: 12 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,15 @@ Web browser with `GUI` loaded will be opened automatically.

## Options

* `--config`, `-c` - specify config file to use.
* `--port`, `-p` - specify port to run `GUI` backend on.
* `--hostname`, `-h` - specify hostname to run `GUI` backend on.
* `--root-url`, `-r` - use specified URL, instead of `rootUrl` setting from config file.
* `--grid-url` - use specified URL, instead of `gridUrl` setting from config file.
* `--screenshots-dir`, `-s` - use specified directory, instead of `screenshotsDir` setting
from config.
* `--grep`, `-g` - find suites by name. Note that if some suite files specified search will be done
only in that files.
* `--debug` - enable debug mode (verbose logging).
* `--auto-run`, `-a` - run gemini immediately (without pressing `run` button).
* `--set`, `-s` - run set specified in config.
* `--no-open`, `-O` - not to open a browser window after starting the server.

You can also override config file options with environment variables. Use `gemini`
[documentation](https://github.com/gemini-testing/gemini#configuration) for details.
* `-V`, `--version` – output the version number
* `-b`, `--browser <browser>` – run test only in the specified browser
* `-p`, `--port <port>` – port to launch server on
* `-h`, `--hostname <hostname>` – hostname to launch server on
* `-c, --config <file>` – gemini config file
* `-g, --grep <pattern>` – run only suites matching the pattern
* `-s`, `--set <set>` – set to run
* `-a`, `--auto-run` – auto run immediately
* `-O`, `--no-open` – not to open a browser window after starting the server
* `-h`, `--help` – output usage information

Also you can override gemini config options via environment variables and CLI options. See gemini [documentation](https://github.com/gemini-testing/gemini#configuration) for details.
15 changes: 7 additions & 8 deletions lib/cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,19 @@ exports.run = () => {
.version(pkg.version)
.allowUnknownOption(true)
.option('-b, --browser <browser>', 'run test only in the specified browser', collect)
.option('-p, --port <port>', 'Port to launch server on', 8000)
.option('-h, --hostname <hostname>', 'Hostname to launch server on', 'localhost')
.option('-c, --config <file>', 'Gemini config file', path.resolve, '')
.option('-p, --port <port>', 'port to launch server on', 8000)
.option('-h, --hostname <hostname>', 'hostname to launch server on', 'localhost')
.option('-c, --config <file>', 'gemini config file', path.resolve, '')
.option('-g, --grep <pattern>', 'run only suites matching the pattern', RegExp)
.option('-s, --set <set>', 'set to run', collect)
.option('-a, --auto-run', 'auto run immediately')
.option('-O, --no-open', 'not to open a browser window after starting the server')
.on('--help', () => {
console.log('\n Also you can override gemini config options via environment variables and CLI options.' +
' See gemini documentation for details.');
})
.parse(process.argv);

program.on('--help', () => {
console.log('Also you can override gemini config options.');
console.log('See all possible options in gemini documentation.');
});

program.testFiles = [].concat(program.args);
server.start(program).then((result) => {
console.log(`GUI is running at ${chalk.cyan(result.url)}`);
Expand Down