https://github.com/maelgangloff/scolengo-cli

Export my data from the Skolengo API (Unofficial)
https://github.com/maelgangloff/scolengo-cli

api cli kdecole kosmos nodejs skolengo

Last synced: 4 months ago
JSON representation

Export my data from the Skolengo API (Unofficial)

Host: GitHub
URL: https://github.com/maelgangloff/scolengo-cli
Owner: maelgangloff
License: gpl-3.0
Created: 2023-05-02T20:54:40.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2024-05-01T20:58:40.000Z (about 2 years ago)
Last Synced: 2025-10-01T09:52:44.435Z (9 months ago)
Topics: api, cli, kdecole, kosmos, nodejs, skolengo
Language: TypeScript
Homepage: https://www.npmjs.com/package/scolengo-cli
Size: 7.15 MB
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

# scolengo-cli
[![view on npm](http://img.shields.io/npm/v/scolengo-cli.svg?style=flat-square)](https://www.npmjs.org/package/scolengo-cli)
[![Discord](https://img.shields.io/discord/1095829734211977276?label=Discord&style=flat-square)](https://discord.gg/9u69mxsFT6)
[![npm](https://img.shields.io/npm/dm/scolengo-cli?style=flat-square)](https://npm-stat.com/charts.html?package=scolengo-cli)

Une application console non-officielle permettant d'exporter ses données provenant de l'API Skolengo.
Cet utilitaire utilise la librairie [scolengo-api](https://github.com/maelgangloff/scolengo-api) pour permettre le téléchargement de vos propres données depuis le serveur API.

> [!WARNING]
> ## Disclaimer
> - Il est clairement mentionné que cette librairie n'est pas officiellement éditée par la société éditrice du logiciel *Skolengo*.
> - Ce module n'est pas une contrefaçon car il n'existe pas de module similaire édité officiellement.
> - Les utilisateurs ne peuvent accéder qu'à leurs propres données. Ils sont soumis au même processus d'authentification que celui implémenté dans l'application et imposé par le serveur API.
> - Les données des utilisateurs ne sont pas davantage exposées puisqu'un utilisateur ne peut accéder qu'à ses propres données. Personne n'a le contrôle sur cette limitation qui est inhérente au fonctionnement de l'API des serveurs de Skolengo.
> - Cette librairie ne se suffit pas à elle-même pour fonctionner. Il est nécessaire de l'importer dans un projet et l'utilisateur est le seul responsable de son code et des éventuelles conséquences.
> - Tout utilisateur de cette librairie a *a priori* lu et approuvé l'entièreté du fichier de licence GPLv3 disponible publiquement [LICENSE](https://github.com/maelgangloff/scolengo-cli/blob/master/LICENSE) ainsi que de ce présent fichier de présentation.
> - Tout utilisateur de cette librairie a *a priori* lu et compris l'entièreté du code de ce projet avant toute utilisation.
> - L'auteur de ce projet n'agit pas en tant qu'intermédiaire de traitement des données au sens du RGPD. Les utilisateurs sont responsables de leur propre conformité au RGPD lors de l'utilisation de cette librairie. Ils doivent s'assurer que leur utilisation de cette librairie est conforme aux exigences du RGPD et de toute autre législation applicable en matière de protection des données.
> - Eu égard l'ensemble de ces remarques, les contributeurs et *a fortiori* l'auteur du projet ne peuvent être tenus responsables de tout dommage potentiel.

## Installation et mise à jour

```shell
npm i -g scolengo-cli
```

![Interactive CLI](docs/interactive.gif)

## Usage
### Commandes principales
```
_ _ _
___ ___ ___ | | ___ _ __ __ _ ___ ___| (_)
/ __|/ __/ _ \| |/ _ \ '_ \ / _` |/ _ \ _____ / __| | |
\__ \ (_| (_) | | __/ | | | (_| | (_) |_____| (__| | |
|___/\___\___/|_|\___|_| |_|\__, |\___/ \___|_|_|
|___/

Avertissement : Cet utilitaire n'est pas édité par Skolengo et n'est en aucun cas lié à cette marque.
Il s'agit d'une application non-officielle, Open Source et distribué sous licence GNU GPLv3.
Le dépôt git est accessible en suivant ce lien : https://github.com/maelgangloff/scolengo-cli

Usage: scolengo [options] [command]

Exporter mes données accessibles depuis l'API Skolengo

Options:
-V, --version output the version number
-h, --help display help for command

Commands:
auth gérer l'authentification
export exporter des données
help [command] display help for command

```

### Authentification
```
Usage: scolengo auth [options] [command]

Gérer l'authentification

Options:
-h, --help display help for command

Commands:
login se connecter à partir d'un fichier de configuration obtenu avec https://github.com/maelgangloff/scolengo-token
logout [options] se déconnecter et révoquer le refresh token
clear supprimer toute la configuration de scolengo-cli
whoami [options] vérifier si l'utilisateur courant est correctement authentifié
refresh [options] forcer le renouvellement de l'access token
help [command] display help for command
```

### Exporter des données
#### Calendar
```
Usage: scolengo export calendar [options] [output-file]

Exporter l'agenda au format iCalendar (text/calendar)