Skip to content

docs(cli): add v1.2.0 #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 14, 2022
Merged

docs(cli): add v1.2.0 #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c10ef55
docs(cli): add v1.2.0
theoludwig Jul 13, 2022
854f4a3
docs(cli): add French translations
louistiti Jul 14, 2022
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
22 changes: 11 additions & 11 deletions docs/guide/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ sidebar_position: 5

# CLI

CLI stands for *Command-Line Interface*. You can see it as the companion that helps you with your Leon journey.
CLI stands for _Command-Line Interface_. You can see it as the companion that helps you with your Leon journey.

For the moment, the CLI helps you for the setup of Leon. In the future more commands will be released to improve your comfort and make the use of Leon even smoother.

## Commands

The table below lists all the available commands:

| Command | Description | Option |
| ----------------------------------------|--------------------|---|
| `leon check` | Check how the setup went. | <ul><li>`--name {name}`: name of the Leon instance.</li></ul> |
| `leon create birth` | Brings Leon to life by checking all the requirements and install them with your approval. | <ul><li>`--develop`: install Leon from the `develop` Git branch.</li><li>`--docker`: install Leon with Docker.</li><li>`--path {path}`: location of your Leon instance.</li><li>`--version {version}`: install a [specific version](https://github.com/leon-ai/leon/releases) of Leon.</li><li>`--name {name}`: give a name to your Leon instance.</li><li>`--no-git`: Install Leon without `git` (by default if possible it installs Leon with `git`)</li><li>`--yes`: skip all questions with a "yes" answer.</li></ul> |
| `leon help` | List all commands available in the CLI. | |
| `leon start` | Start a Leon instance. | <ul><li>`--port {port}`: run a Leon instance with a specific port.</li><li>`--name {name}`: run a Leon instance with a specific name.</li></ul> |
| `leon info` | Get basic information about installed Leon instances. | <ul><li>`--name {name}`: Name of the Leon instance.</li></ul> |
| `leon delete` | Delete a Leon instance. | <ul><li>`--name {name}`: Name of the Leon instance.</li><li>`--yes`: skip all questions with a "yes" answer.</li></ul> |
| `leon update` | Update a Leon instance. | <ul><li>`--name {name}`: Name of the Leon instance.</li><li>`--develop`: Update Leon to latest `develop` Git branch.</li><li>`--version {version}`: Update to a [specific version](https://github.com/leon-ai/leon/releases) of Leon.</li><li>`--no-git`: Update Leon without `git` (by default if possible it updates Leon with `git`)</li><li>`--yes`: skip all questions with a "yes" answer.</li></ul> |
| `leon run` | Run a npm script from a Leon Instance (e.g: `leon run train` runs `npm run train` in the leon instance folder). | <ul><li>`--name {name}`: Name of the Leon instance.</li></ul> |
| Command | Description | Option |
| ------------------- |-----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `leon check` | Check how the setup went. | <ul><li>`--name {name}`: name of the Leon instance.</li></ul> |
| `leon create birth` | Brings Leon to life by checking all the requirements and install them if needed. | <ul><li>`--develop`: install Leon from the `develop` Git branch.</li><li>`--docker`: install Leon with Docker.</li><li>`--path {path}`: location of your Leon instance.</li><li>`--version {version}`: install a [specific version](https://github.com/leon-ai/leon/releases) of Leon.</li><li>`--name {name}`: give a name to your Leon instance.</li><li>`--no-git`: install Leon without using Git (by default it installs Leon with Git if possible).</li><li>`--interactive`: interactive mode (ask questions).</li></ul> |
| `leon help` | List all commands available in the CLI. | |
| `leon start` | Start a Leon instance. | <ul><li>`--port {port}`: run a Leon instance with a specific port.</li><li>`--name {name}`: run a Leon instance with a specific name.</li></ul> |
| `leon info` | Get basic information about installed Leon instances. | <ul><li>`--name {name}`: name of the Leon instance.</li></ul> |
| `leon delete` | Delete a Leon instance. | <ul><li>`--name {name}`: name of the Leon instance.</li><li>`--yes`: skip all questions with a "yes" answer.</li></ul> |
| `leon update` | Update a Leon instance. | <ul><li>`--name {name}`: name of the Leon instance.</li><li>`--develop`: update Leon to latest `develop` Git branch.</li><li>`--version {version}`: update to a [specific version](https://github.com/leon-ai/leon/releases) of Leon.</li><li>`--no-git`: update Leon without Git (by default it updates Leon by using Git if possible).</li></ul> |
| `leon run` | Run a npm script from a Leon Instance (e.g: `leon run train` runs `npm run train` in the leon instance folder). | <ul><li>`--name {name}`: name of the Leon instance.</li></ul> |
16 changes: 10 additions & 6 deletions i18n/fr-FR/docusaurus-plugin-content-docs/current/guide/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,13 @@ Pour le moment, la CLI vous aide à installer Léon. À l'avenir plus de command

Le tableau ci-dessous liste toutes les commandes disponibles :

| Commande | Description | Option |
| ----------------------------------------|--------------------|---|
| `leon check` | Vérifie comment l'installation s'est déroulée. | <ul><li>`--name`: nom d'une instance Léon.</li></ul> |
| `leon create birth` | Donne vie à Léon en vérifiant tous les prérequis et en les installant avec votre accord si ces derniers ne sont pas déjà installés. | <ul><li>`--develop`: installe Léon depuis la branche Git `develop`.</li><li>`--docker`: installe Léon avec Docker.</li><li>`--path {path}`: chemin de votre instance Léon.</li><li>`--version {version}`: installe une [version spécifique](https://github.com/leon-ai/leon/releases) de Léon.</li><li>`--name {name}`: donne un nom à votre instance Léon.</li><li>`--yes`: passe toutes les questions en réponsant "oui".</li></ul> |
| `leon help` | Liste toutes les commandes disponibles de la CLI. | |
| `leon start` | Lance une instance de Léon. | <ul><li>`--port {port}`: lance une instance de Léon sur un port spécifique.</li><li>`--name {name}`: lance une instance de Léon avec un nom spécifique.</li></ul> |
| Command | Description | Option |
| ------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `leon check` | Vérifie comment l'installation s'est déroulée. | <ul><li>`--name {name}`: nom d'une instance Léon.</li></ul> |
| `leon create birth` | Donne vie à Léon en vérifiant tous les prérequis et en les installant si besoin. | <ul><li>`--develop`: installe Léon depuis la branche Git `develop`.</li><li>`--docker`: installe Léon avec Docker.</li><li>`--path {path}`: chemin de votre instance Léon.</li><li>`--version {version}`: installe une [version spécifique](https://github.com/leon-ai/leon/releases) de Léon.</li><li>`--name {name}`: donne un nom à votre instance Léon.</li><li>`--no-git`: installe Léon sans utiliser Git (par défaut Git est utilisé si possible).</li><li>`--interactive`: mode intéractif (pose des questions).</li></ul> |
| `leon help` | Liste toutes les commandes disponibles de la CLI. | |
| `leon start` | Lance une instance de Léon. | <ul><li>`--port {port}`: lance une instance de Léon sur un port spécifique.</li><li>`--name {name}`: lance une instance de Léon avec un nom spécifique.</li></ul> |
| `leon info` | Liste les informations à propos des instances installées. | <ul><li>`--name {name}`: nom d'une instance Léon.</li></ul> |
| `leon delete` | Supprime une instance Léon. | <ul><li>`--name {name}`: nom d'une instance Léon.</li><li>`--yes`: passer toutes les questions avec la réponse "oui".</li></ul> |
| `leon update` | Mettre à jour une instance Léon. | <ul><li>`--name {name}`: nom d'une instance Léon.</li><li>`--develop`: mettre à jour Léon avec les derniers changements de la branche Git `develop`.</li><li>`--version {version}`: mettre à jour une [version spécifique](https://github.com/leon-ai/leon/releases) de Léon.</li><li>`--no-git`: installe Léon sans utiliser Git (par défaut Git est utilisé si possible).</li></ul> |
| `leon run` | Exécuter un script npm depuis une instance Léon (Ex. `leon run train` exécute `npm run train` dans le dossier de l'instance). | <ul><li>`--name {name}`: nom d'une instance Léon.</li></ul> |