turbo-editors/turbo-golo · cli.md

⑂ v1.0.1

cli.md · 110 lines · 5.8 KBmarkdown    Blame HistoryRaw
📦 Turbo Golo   1# Référence : ligne de commande
3> Description neutre de la commande `turbo-golo`, de ses options et de l'environnement qu'elle lit.
5## Synopsis
8turbo-golo [options] [fichier...]
11Chaque `fichier` est ouvert dans sa propre fenêtre. Un fichier qui n'existe pas encore est ouvert comme un tampon vide associé à ce chemin. Sans aucun fichier, une seule fenêtre vide sans titre est ouverte.
13
Option | Type | Défaut | Description |
--- | --- | --- | --- |
`-theme <nom>` | chaîne | celui du projet, sinon `turbo-classic` | Thème de démarrage, l'emportant sur celui du projet. Un nom inconnu retombe sur le thème par défaut sans erreur. |
`-list-themes` | booléen | `false` | Affiche chaque thème chargeable avec sa description, puis le répertoire de thèmes utilisateur, et quitte. |
`-no-lsp` | booléen | `false` | Ne démarre pas de serveur de langage. La coloration et l'édition sont inchangées. |
`-version` | booléen | `false` | Affiche `Turbo Golo <version>` sur une ligne, avec le commit et la date de build quand le build les a enregistrés, puis quitte. Voir [le numéro de version](versioning.md). |
`-h`, `-help` | booléen | `false` | Affiche la liste des options et quitte. |
23## Environnement
Variable | Lue par | Effet |
--- | --- | --- |
`TURBO_GOLO_DIR` | répertoire utilisateur | Remplace `~/.config/turbo-golo` : les thèmes sont alors lus dans `$TURBO_GOLO_DIR/themes`, et vos snippets dans `$TURBO_GOLO_DIR/snippets.toml`. |
`TURBO_GOLO_THEME_DIR` | chargement des thèmes | Répertoire des thèmes utilisateur, à la place de `<répertoire utilisateur>/themes`. |
`TURBO_GOLO_SNIPPET_DIR` | chargement des snippets | Répertoire contenant votre `snippets.toml`, à la place du répertoire utilisateur. |
`PATH` | recherche de `golo` | Consulté en premier ; `/usr/local/bin` est ensuite regardé même s'il n'y figure pas. Aucune variable ne nomme un autre répertoire. |
`TERM` | tcell | Description de terminal à utiliser. |
`SHELL` | fenêtres terminal | Le shell qu'ouvre `F8` ; `/bin/sh` si elle est absente. |
34## Fichiers
Chemin | Rôle |
--- | --- |
`./.turbo-golo/settings.toml` | Les réglages de ce projet, lus au démarrage puis à chaque enregistrement. Voir [réglages de projet](project-settings.md). |
`./.turbo-golo/snippets.toml` | Les snippets de ce projet. Voir [snippets](snippets.md). |
`./.turbo-golo/tools.toml` | Les outils du menu Golo. Voir [outils Golo](golo-tools.md). |
`~/.config/turbo-golo/themes/*.toml` | Thèmes utilisateur sous Linux (`os.UserConfigDir`). |
`~/Library/Application Support/turbo-golo/themes/*.toml` | Thèmes utilisateur sous macOS. |
`~/.config/turbo-golo/snippets.toml` | Vos snippets, partagés entre projets. |
`$TURBO_GOLO_THEME_DIR/*.toml` | Thèmes utilisateur, quand la variable est définie. |
`/usr/local/bin/golo` | Le serveur de langage, quand `golo` n'est pas dans le `PATH`. |
47Le serveur de langage reçoit comme racine le dossier du premier fichier nommé sur la ligne de commande, ou le répertoire de travail quand aucun ne l'est. Aucun fichier marqueur n'est cherché en remontant : Golo n'a pas de manifeste de projet.
49## Code de sortie
Code | Signification |
--- | --- |
`0` | L'éditeur s'est terminé normalement, ou une option d'information a été utilisée. |
`1` | Le terminal n'a pas pu être ouvert ou initialisé. La raison est écrite sur la sortie d'erreur. |
56## Cibles make
58À exécuter depuis un clone.
Cible | Ce qu'elle lance |
--- | --- |
`make help` | Liste les cibles. C'est la cible par défaut. |
`make test` | `go test ./...` |
`make test-verbose` | `go test -v ./...` |
`make cover` | `go test -cover ./...` |
`make build` | `go build` estampillé dans `bin/turbo-golo`, puis `scripts/check-version.sh` sur le résultat |
`make version` | Affiche la version que ce clone estampillerait, sans construire |
`make ldflags` | Affiche les options d'édition de liens d'un build estampillé |
`make install` | `scripts/install.sh` — compile et installe dans le PATH |
`make uninstall` | `scripts/install.sh --uninstall` |
`make run FILE=x.golo` | `make build`, puis `./bin/turbo-golo x.golo` |
`make fmt` | `go fmt ./...` |
`make vet` | `go vet ./...` |
`make check` | `fmt`, puis `vet`, puis `test` |
`make clean` | Supprime `bin/` |
77## Exemples
80turbo-golo                                    # une fenêtre vide
81turbo-golo main.golo README.md                # deux fenêtres
82turbo-golo -theme turbo-dark main.golo        # un autre thème
83turbo-golo -no-lsp main.golo                  # sans serveur de langage
84turbo-golo -list-themes                       # quels thèmes existent
87## Installateur
89`scripts/install.sh`, également accessible via `make install`.
Option | Description |
--- | --- |
`-p`, `--prefix RÉP` | Installer dans `RÉP` au lieu de `$GOBIN` ou `$GOPATH/bin`. |
`--with-server` | Construire et installer GoloScript — `golo`, `gogolo` et `wagolo` — depuis ses sources, s'il n'est pas déjà présent. |
`--uninstall` | Retirer un `turbo-golo` installé, puis s'arrêter. |
`-h`, `--help` | Afficher les options, puis s'arrêter. |
Code de sortie | Signification |
--- | --- |
`0` | Installé, retiré, ou aide affichée. |
`1` | Go absent ou trop ancien, échec de compilation, ou destination non accessible en écriture. Rien n'est installé et une installation existante reste intacte. |
103
Message | Cause |
--- | --- |
`turbo-golo: opening the terminal: …` | tcell n'a pas pu ouvrir le terminal ; en général `TERM` est absent ou inconnu. |
`turbo-golo: initialising the terminal: …` | Le terminal a été ouvert mais n'a pas pu être mis en mode brut. |
`Cannot open` (dans une boîte) | Le chemin est un répertoire, ou n'est pas lisible. |
`Cannot save` (dans une boîte) | Le répertoire n'existe pas, ou n'est pas accessible en écriture. |

📦 Turbo Golo d710c1b k33g 14h ago	1	# Référence : ligne de commande
	2
	3	> Description neutre de la commande `turbo-golo`, de ses options et de l'environnement qu'elle lit.
	4
	5	## Synopsis
	6
	7	```
	8	turbo-golo [options] [fichier...]
	9	```
	10
	11	Chaque `fichier` est ouvert dans sa propre fenêtre. Un fichier qui n'existe pas encore est ouvert comme un tampon vide associé à ce chemin. Sans aucun fichier, une seule fenêtre vide sans titre est ouverte.
	12
	13	## Options
	14
	15	\| Option \| Type \| Défaut \| Description \|
	16	\| --- \| --- \| --- \| --- \|
	17	\| `-theme <nom>` \| chaîne \| celui du projet, sinon `turbo-classic` \| Thème de démarrage, l'emportant sur celui du projet. Un nom inconnu retombe sur le thème par défaut sans erreur. \|
	18	\| `-list-themes` \| booléen \| `false` \| Affiche chaque thème chargeable avec sa description, puis le répertoire de thèmes utilisateur, et quitte. \|
	19	\| `-no-lsp` \| booléen \| `false` \| Ne démarre pas de serveur de langage. La coloration et l'édition sont inchangées. \|
	20	\| `-version` \| booléen \| `false` \| Affiche `Turbo Golo <version>` sur une ligne, avec le commit et la date de build quand le build les a enregistrés, puis quitte. Voir [le numéro de version](versioning.md). \|
	21	\| `-h`, `-help` \| booléen \| `false` \| Affiche la liste des options et quitte. \|
	22
	23	## Environnement
	24
	25	\| Variable \| Lue par \| Effet \|
	26	\| --- \| --- \| --- \|
	27	\| `TURBO_GOLO_DIR` \| répertoire utilisateur \| Remplace `~/.config/turbo-golo` : les thèmes sont alors lus dans `$TURBO_GOLO_DIR/themes`, et vos snippets dans `$TURBO_GOLO_DIR/snippets.toml`. \|
	28	\| `TURBO_GOLO_THEME_DIR` \| chargement des thèmes \| Répertoire des thèmes utilisateur, à la place de `<répertoire utilisateur>/themes`. \|
	29	\| `TURBO_GOLO_SNIPPET_DIR` \| chargement des snippets \| Répertoire contenant votre `snippets.toml`, à la place du répertoire utilisateur. \|
	30	\| `PATH` \| recherche de `golo` \| Consulté en premier ; `/usr/local/bin` est ensuite regardé même s'il n'y figure pas. Aucune variable ne nomme un autre répertoire. \|
	31	\| `TERM` \| tcell \| Description de terminal à utiliser. \|
	32	\| `SHELL` \| fenêtres terminal \| Le shell qu'ouvre `F8` ; `/bin/sh` si elle est absente. \|
	33
	34	## Fichiers
	35
	36	\| Chemin \| Rôle \|
	37	\| --- \| --- \|
	38	\| `./.turbo-golo/settings.toml` \| Les réglages de ce projet, lus au démarrage puis à chaque enregistrement. Voir [réglages de projet](project-settings.md). \|
	39	\| `./.turbo-golo/snippets.toml` \| Les snippets de ce projet. Voir [snippets](snippets.md). \|
	40	\| `./.turbo-golo/tools.toml` \| Les outils du menu Golo. Voir [outils Golo](golo-tools.md). \|
	41	\| `~/.config/turbo-golo/themes/*.toml` \| Thèmes utilisateur sous Linux (`os.UserConfigDir`). \|
	42	\| `~/Library/Application Support/turbo-golo/themes/*.toml` \| Thèmes utilisateur sous macOS. \|
	43	\| `~/.config/turbo-golo/snippets.toml` \| Vos snippets, partagés entre projets. \|
	44	\| `$TURBO_GOLO_THEME_DIR/*.toml` \| Thèmes utilisateur, quand la variable est définie. \|
	45	\| `/usr/local/bin/golo` \| Le serveur de langage, quand `golo` n'est pas dans le `PATH`. \|
	46
	47	Le serveur de langage reçoit comme racine le dossier du premier fichier nommé sur la ligne de commande, ou le répertoire de travail quand aucun ne l'est. Aucun fichier marqueur n'est cherché en remontant : Golo n'a pas de manifeste de projet.
	48
	49	## Code de sortie
	50
	51	\| Code \| Signification \|
	52	\| --- \| --- \|
	53	\| `0` \| L'éditeur s'est terminé normalement, ou une option d'information a été utilisée. \|
	54	\| `1` \| Le terminal n'a pas pu être ouvert ou initialisé. La raison est écrite sur la sortie d'erreur. \|
	55
	56	## Cibles make
	57
	58	À exécuter depuis un clone.
	59
	60	\| Cible \| Ce qu'elle lance \|
	61	\| --- \| --- \|
	62	\| `make help` \| Liste les cibles. C'est la cible par défaut. \|
	63	\| `make test` \| `go test ./...` \|
	64	\| `make test-verbose` \| `go test -v ./...` \|
65	\| `make cover` \| `go test -cover ./...` \|
66	\| `make build` \| `go build` estampillé dans `bin/turbo-golo`, puis `scripts/check-version.sh` sur le résultat \|
67	\| `make version` \| Affiche la version que ce clone estampillerait, sans construire \|
68	\| `make ldflags` \| Affiche les options d'édition de liens d'un build estampillé \|
69	\| `make install` \| `scripts/install.sh` — compile et installe dans le PATH \|
70	\| `make uninstall` \| `scripts/install.sh --uninstall` \|
71	\| `make run FILE=x.golo` \| `make build`, puis `./bin/turbo-golo x.golo` \|
72	\| `make fmt` \| `go fmt ./...` \|
73	\| `make vet` \| `go vet ./...` \|
74	\| `make check` \| `fmt`, puis `vet`, puis `test` \|
75	\| `make clean` \| Supprime `bin/` \|
76
77	## Exemples
78
79	```bash
80	turbo-golo # une fenêtre vide
81	turbo-golo main.golo README.md # deux fenêtres
82	turbo-golo -theme turbo-dark main.golo # un autre thème
83	turbo-golo -no-lsp main.golo # sans serveur de langage
84	turbo-golo -list-themes # quels thèmes existent
85	```
86
87	## Installateur
88
89	`scripts/install.sh`, également accessible via `make install`.
90
91	\| Option \| Description \|
92	\| --- \| --- \|
93	\| `-p`, `--prefix RÉP` \| Installer dans `RÉP` au lieu de `$GOBIN` ou `$GOPATH/bin`. \|
94	\| `--with-server` \| Construire et installer GoloScript — `golo`, `gogolo` et `wagolo` — depuis ses sources, s'il n'est pas déjà présent. \|
95	\| `--uninstall` \| Retirer un `turbo-golo` installé, puis s'arrêter. \|
96	\| `-h`, `--help` \| Afficher les options, puis s'arrêter. \|
97
98	\| Code de sortie \| Signification \|
99	\| --- \| --- \|
100	\| `0` \| Installé, retiré, ou aide affichée. \|
101	\| `1` \| Go absent ou trop ancien, échec de compilation, ou destination non accessible en écriture. Rien n'est installé et une installation existante reste intacte. \|
102
103	## Erreurs
104
105	\| Message \| Cause \|
106	\| --- \| --- \|
107	\| `turbo-golo: opening the terminal: …` \| tcell n'a pas pu ouvrir le terminal ; en général `TERM` est absent ou inconnu. \|
108	\| `turbo-golo: initialising the terminal: …` \| Le terminal a été ouvert mais n'a pas pu être mis en mode brut. \|
109	\| `Cannot open` (dans une boîte) \| Le chemin est un répertoire, ou n'est pas lisible. \|
110	\| `Cannot save` (dans une boîte) \| Le répertoire n'existe pas, ou n'est pas accessible en écriture. \|