Attachement de fichiers avec l’interface CLI GitHub

Joignez des images locales et des vidéos à des problèmes, des demandes de tirage et des commentaires sans quitter la ligne de commande.

Dans cet article

Vous pouvez joindre une image ou une vidéo locale à GitHub CLI depuis la ligne de commande à l’aide de l’indicateur --attach. GitHub CLI charge le fichier dans GitHub et écrit l’URL résultante dans le corps de votre problème, demande de tirage ou commentaire, de sorte qu’il s’affiche en ligne comme si vous l’avez attaché dans votre navigateur.

Vous avez besoin d’un accès push au référentiel pour joindre des fichiers.

L’indicateur --attach est disponible sur les commandes suivantes :

  • gh issue create
  • gh issue edit
  • gh issue comment
  • gh pr create
  • gh pr edit
  • gh pr comment

Attachement d’un fichier

Transmettez --attach avec le chemin d’accès vers un fichier local. Dans l’exemple suivant, remplacez ISSUE-NUMBER par le nombre de votre problème et PATH/TO/IMAGE par le chemin d’accès à votre image. Vous pouvez répéter l’indicateur pour joindre plusieurs fichiers, mais vous ne pouvez pas joindre le même fichier deux fois.

gh issue comment ISSUE-NUMBER --attach PATH/TO/IMAGE

Vous pouvez combiner --attach avec --body ou --body-file incorporer des images et des vidéos dans votre Markdown. L’exemple suivant utilise des espaces réservés pour le titre de la pull request, le fichier Markdown pour le corps du texte et deux fichiers d’image.

gh pr create \
  --title "PULL-REQUEST-TITLE" \
  --body-file PATH/TO/BODY-FILE \
  --attach PATH/TO/FIRST-IMAGE \
  --attach PATH/TO/SECOND-IMAGE

Pour définir le texte de remplacement d’une image, ajoutez-le à la fin du chemin après un #, à la place de ALT-TEXT.

gh issue comment ISSUE-NUMBER --attach 'PATH/TO/IMAGE#ALT-TEXT'

Si vous ne fournissez pas de texte de remplacement, GitHub CLI utilisez le nom de fichier.

Remarque

Le texte de remplacement n’est pas pris en charge sur les fichiers vidéo.

Incorporation d’une pièce jointe dans Markdown

Si votre texte Markdown fait déjà référence à un fichier local et que vous attachez ce même fichier avec --attach, GitHub CLI réécrit la référence en place pour pointer sur le fichier chargé, plutôt que d’ajouter une deuxième copie à la fin. Cela vous permet d’écrire Markdown avec des chemins locaux ordinaires, de l’afficher localement là où les images s’affichent, puis de la publier inchangée. La référence est réécrite, quel que soit l’endroit où provient le corps du texte : --body, , --body-fileentrée standard ou éditeur de texte.

Incorporation d’une image

Par exemple, enregistrez le contenu suivant dans PATH/TO/BODY-FILE:

The sign-in screen shows an error where the form should be:

![the sign-in screen showing an authentication error](PATH/TO/IMAGE)

Exécutez la commande suivante avec --body-file:

gh issue comment \
  ISSUE-NUMBER \
  --body-file PATH/TO/BODY-FILE \
  --attach PATH/TO/IMAGE

GitHub CLI remplace le chemin local par l’URL téléversée et conserve votre Markdown ainsi que votre texte alternatif. Lorsqu’une référence est réécrite, le texte de remplacement provient de Markdown. Par conséquent, tout # texte de remplacement sur l’indicateur s’applique uniquement aux fichiers ajoutés.

Tout fichier joint auquel le corps du message ne fait pas référence est ajouté à la fin du corps du message, dans l’ordre où vous avez fourni les indicateurs.

Incorporation d’une vidéo

Pour incorporer une vidéo en tant que lecteur, enregistrez la référence d’image Markdown suivante dans PATH/TO/VIDEO-BODY-FILE. La référence doit être le seul contenu de son paragraphe.

![](PATH/TO/VIDEO)

Attachez ensuite la même vidéo :

gh issue comment \
  ISSUE-NUMBER \
  --body-file PATH/TO/VIDEO-BODY-FILE \
  --attach PATH/TO/VIDEO

GitHub CLI remplace l’intégralité de la référence par l’URL importée, qui s’affiche sous forme de lecteur. Si la référence apparaît dans une phrase, elle s’affiche en tant que lien à la place.

Limitations

GitHub CLI prend uniquement en charge le téléchargement de fichiers image et multimédias. Pour obtenir la liste des types de fichiers pris en charge, consultez Joindre des fichiers.