Skip to content

Commit 6e6fe83

Browse files
committed
docs(cli): Add auth doc
1 parent 1d9504d commit 6e6fe83

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

docs/guides/1-lighthouse-ecoindex-cli.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ Sert à lancer la collecte des audits Lighthouse et EcoIndex suivant les options
105105
- `-o, --output` : Rapporteur pour les résultats, supporte plusieurs valeurs. Choix : "json", "html", "statement". ATTENTION : "csv" n'est pas disponible.
106106
- `-a, --audit-category` : Audit à exécuter, supporte plusieurs valeurs.
107107
- `--user-agent` : User-Agent à utiliser pour les requêtes.
108+
- `--auth` : Moyen de s'authentifier pendant les mesures (`--auth.url`, `--auth.user.target`, `--auth.user.value`, etc. voir le tableau plus bas).
108109
- `--help` : Affiche l'aide.
109110

110111
#### Exemples
@@ -147,19 +148,24 @@ Le format du fichier doit être respecté !
147148

148149
##### Explications
149150

150-
| Propriété | Type | Description |
151-
| ----------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------- |
152-
| `extra-header` | `object` | Les informations nécessaires pour votre audit (authentification, cookies, etc). |
153-
| `output` | `array` | Les types d'export souhaités : `"html", "json", "statement"` (statement = déclation environnementale). |
154-
| `user-agent` | `string` | `"random"` ou un user agent spécifique. Utilisez `"random"` pour ne pas vous faire détecter et bloquer par les anti-bot. |
155-
| `output-path` | `string` | Dossier ou exporter les rapports. |
156-
| `output-name` | `string` | _je ne sais plus._ :) |
157-
| `courses` | `array` | Les parcours à auditer. |
158-
| `courses.name` | `string` | nom du parcours, qui sera affiché dans la déclaration en environnementale. |
159-
| `courses.target` | `string` | Objectif du parcours, qui sera affiché dans la déclaration en environnementale. |
160-
| `courses.course` | `string` | Parcours cible. Rapide liste des pages parcourues, qui sera affichée dans la déclaration en environnementale. |
161-
| `courses.is-best-pages` | `boolean` | Indique si ce parcours est celui utilisé dans la déclaration environnementale comme les 5 pages les plus visitées du site. |
162-
| `courses.urls` | `array` | Liste des urls à mesurer. |
151+
| Propriété | Type | Description |
152+
| ----------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------- |
153+
| `extra-header` | `object` | Les informations nécessaires pour votre audit (authentification, cookies, etc). |
154+
| `output` | `array` | Les types d'export souhaités : `"html", "json", "statement"` (statement = déclation environnementale). |
155+
| `user-agent` | `string` | `"random"` ou un user agent spécifique. Utilisez `"random"` pour ne pas vous faire détecter et bloquer par les anti-bot. |
156+
| `output-path` | `string` | Dossier ou exporter les rapports. |
157+
| `courses` | `array` | Les parcours à auditer. |
158+
| `courses.name` | `string` | nom du parcours, qui sera affiché dans la déclaration en environnementale. |
159+
| `courses.target` | `string` | Objectif du parcours, qui sera affiché dans la déclaration en environnementale. |
160+
| `courses.course` | `string` | Parcours cible. Rapide liste des pages parcourues, qui sera affichée dans la déclaration en environnementale. |
161+
| `courses.is-best-pages` | `boolean` | Indique si ce parcours est celui utilisé dans la déclaration environnementale comme les 5 pages les plus visitées du site. |
162+
| `courses.urls` | `array` | Liste des urls à mesurer. |
163+
| `auth` | `object` | Gestion de l'authentification. |
164+
| `auth.url` | `string` | Url de la page d'authentification (**MANDATORY** Cette URL doit aussi être indiquée dans les URLs à mesurer dans les parcours). |
165+
| `auth.user.target` | `string` | Target (.class ou #id) du champs de l'identifiant de l'utilisateur. |
166+
| `auth.user.value` | `string` | Valeur de l'identifiant de l'utilisateur. |
167+
| `auth.pass.target` | `string` | Target (.class ou #id) du champs du password de l'utilisateur. |
168+
| `auth.pass.value` | `string` | Valeur du password de l'utilisateur. |
163169

164170
### command `convert`
165171

0 commit comments

Comments
 (0)