Home CLI Commands

CLI Commands

Promethee-Selenium provides a powerful command-line interface to streamline your automation workflow. This guide covers all available commands and their usage.

The init Command

The promethee-selenium init command scaffolds a complete, production-ready project structure with best-practice architecture. This is the fastest way to get started with Promethee-Selenium.

Usage

Run the following command in your desired project directory:

promethee-selenium init

Options

--project-name - Specify the project name (default: promethee-project)
--language - Choose between 'en' (English) or 'fr' (French)
--browser - Select the default browser (chrome, firefox, edge)

Example

promethee-selenium init --project-name my-tests --browser chrome

Generated Structure

After running init, your directory will contain:

my-tests/
├── scenarios/
│   ├── __init__.py
│   └── login_page.py
├── tests/
│   ├── __init__.py
│   └── test_login.py
├── data/
│   ├── credentials.csv
│   └── config.env
├── conftest.py
├── pytest.ini
└── README.md

The docs Command

The promethee-selenium docs command opens the interactive documentation and quick-reference guide in your default browser.

Usage

Simply run:

promethee-selenium docs

Features

Full HTML documentation with code examples and best practices
Interactive Code Object Model (POM) guide
Built-in utilities reference
Environment management guide
Bilingual support (English and French)

Example

promethee-selenium docs

This will automatically open http://localhost:8000 in your default browser, displaying the full documentation site you are currently viewing.

Tips

Use the language toggle to switch between English and French
Use the theme toggle to switch between light and dark modes
Bookmark this page for quick reference during development