Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.replit.com/llms.txt

Use this file to discover all available pages before exploring further.

Les applications Replit sont configurées avec deux fichiers : .replit et replit.nix. Ils influencent le comportement de votre application Replit, de l’exécution du code aux outils de développement et aux langages. Ces fichiers de configuration sont masqués par défaut. Affichez-les dans votre application Replit en sélectionnant « Afficher les fichiers cachés » dans le menu de l’arborescence de fichiers.
image

Fichier replit.nix

Replit utilise Nix pour gérer les packages et les environnements. Le fichier replit.nix est utilisé pour : Spécifier les dépendances système : Définir exactement les packages logiciels requis par votre application Replit, gérés via Nix, un gestionnaire de packages. Créer des environnements reproductibles : Garantir que votre environnement de développement est cohérent et reproductible, idéal pour les projets collaboratifs et les tests sur plusieurs systèmes. Vous pouvez gérer visuellement les packages Nix via l’outil Dependencies. En savoir plus dans le guide Dépendances système. Pour configurer les packages avec le fichier replit.nix, vous pouvez lister les packages Nix dans le tableau deps, préfixés par pkgs.. Toute modification sera synchronisée après le rechargement de votre shell.
{ pkgs }: {
  deps = [
    pkgs.nodejs-19_x
    pkgs.nodePackages.typescript-language-server
    pkgs.yarn
    pkgs.replitPackages.jest
  ];
}

Fichier .replit

Le fichier .replit contrôle le comportement de votre application Replit. Il utilise le format de configuration toml. Voici quelques-uns des aspects clés qui peuvent être configurés : Commande d’exécution : Spécifier la commande qui s’exécute lorsque le bouton Exécuter est sélectionné. Chaque modèle possède une commande d’exécution par défaut permettant d’exécuter du code immédiatement. Pour des applications plus personnalisées et complexes, utilisez les Workflows. Language Server Protocol (LSP) : Fournit des fonctionnalités telles que l’autocomplétion, la navigation dans le code, la coloration syntaxique, ainsi que le linting et la détection d’erreurs en temps réel. Variables d’environnement : Définir et gérer les variables d’environnement essentielles au bon fonctionnement de vos applications. Dépendances et packages : Gérer les installations de packages et les configurations directement via le fichier .replit, garantissant que votre application Replit dispose de tous les outils nécessaires au démarrage. Vous pouvez gérer visuellement les dépendances via l’outil Dependencies. En savoir plus dans le guide Modules système. Pour les applications Python, le fichier .replit par défaut ressemble à :
entrypoint = "main.py"
modules = ["python-3.10:v18-20230807-322e88b"]

[nix]
channel = "stable-23_05"

[unitTest]
language = "python3"

[gitHubImport]
requiredFiles = [".replit", "replit.nix"]

[deployment]
run = ["python3", "main.py"]
deploymentTarget = "cloudrun"
Le tableau suivant présente chaque paramètre du fichier .replit, en expliquant ce que fait chaque configuration et son impact sur l’environnement de l’application Replit.
Clé de configurationValeur/ExempleDescription
entrypointmain.pySpécifie le fichier principal à exécuter et affiché par défaut à l’ouverture de l’éditeur. Vous pouvez renommer le fichier en fonction de votre application.
modules["python-3.10:v18-20230807-322e88b"]Définit les versions spécifiques des langages de programmation ou d’autres dépendances majeures prises en charge par Replit.
[nix]Spécifie les paramètres d’utilisation de Nix, un gestionnaire de packages, pour gérer les dépendances système. Consultez le document Gestion des dépendances pour plus d’informations.
channelstable-23_05Indique le canal Nix à utiliser, ce qui influe sur les versions des dépendances système disponibles.
packages["cowsay", "htop"]Spécifie certains packages Nix à installer. Pour un contrôle plus précis, vous pouvez également utiliser replit.nix.
[unitTest]Configure les paramètres liés aux tests unitaires dans l’application Replit.
languagepython3Spécifie le langage utilisé pour les tests unitaires, indiquant que Python 3 est utilisé pour écrire les tests.
[gitHubImport]Paramètres qui influencent la façon dont les projets sont importés depuis GitHub, notamment les fichiers devant être inclus.
requiredFiles[".replit", "replit.nix"]Liste les fichiers devant être présents lors de l’importation du projet pour garantir son bon fonctionnement.
[deployment]Contient les paramètres de déploiement de l’application depuis l’application Replit vers un environnement en production.
run["python3", "main.py"]Commande exécutée pour démarrer l’application lors du déploiement.
deploymentTargetcloudrunSpécifie la plateforme de déploiement cible pour héberger l’application.
Maintenant que vous avez une idée des configurations par défaut du fichier .replit, utilisez les sections suivantes pour comprendre comment configurer les paramètres de base et avancés de votre application Replit.

Configuration des paramètres de base

Point d’entrée

Il s’agit du fichier principal de votre projet. Si vous ne définissez pas de propriété run, entrypoint est le fichier exécuté par le runtime.
entrypoint = "<nom-du-fichier>.py"

Commande Run

La propriété run dans le fichier .replit est une fonctionnalité clé qui détermine la commande initiale ou la série de commandes exécutées lorsque le bouton Run est sélectionné dans un environnement Replit. La commande Run peut être spécifiée soit sous forme de chaîne représentant la commande à exécuter, soit sous forme de tableau de chaînes représentant la commande et ses arguments individuels. Voici quelques façons courantes de configurer la commande Run :
  • Commande unique : Cet exemple montre comment passer une seule commande à exécuter directement dans l’application Replit. Avec cette configuration dans votre fichier .replit, appuyer sur le bouton Run affichera un message de bienvenue dans le panneau Console : Exemple : run = "echo 'Hello, Replit!'"
  • Arguments explicites : Dans certaines situations, il peut être utile d’être plus explicite, en évitant d’analyser les guillemets ou les règles d’interpolation du shell. Vous pouvez réécrire l’exemple ci-dessus en séparant les arguments. Remarque : vous n’avez plus besoin à la fois de ' et ", car vous passez explicitement le message de bienvenue comme premier et unique argument à echo : Exemple : run = ["echo", "Hello, Replit!"]
  • Commandes multiples : Cet exemple montre comment exécuter plusieurs processus simultanément, comme un frontend et un backend. Cela peut être utile si vous développez un backend Python et un frontend TypeScript, où chaque serveur se lie à un port différent : Exemple : run = "python -m app & npm run start & wait"

Gestion des processus

Bien que plusieurs commandes puissent être exécutées simultanément avec &, vous souhaiterez peut-être une meilleure expérience pour distinguer les journaux entre les services. Vous pouvez ajouter des dépendances système comme process-compose pour mieux orchestrer plusieurs processus.

Phase Build

Pour certains langages ou runtimes, il existe une phase de compilation distincte avant que le code puisse être run. Cela couvre à la fois les langages compilés comme TypeScript, Golang ou Java, ou offre un paramètre que vous pouvez utiliser pour réinitialiser votre environnement, vos données ou votre configuration avant que le prochain run soit invoqué.
  • Compilation : Dans un dépôt TypeScript, vous devrez peut-être exécuter tsc avant d’exécuter votre code. Exemple :
build = "tsc app.ts"
run = "node app.js"

Inclusion de variables d’environnement

Pour fournir des variables d’environnement à votre service avant son exécution, vous pouvez développer la propriété run en table. Il s’agit d’une modification plus complexe qui nécessite probablement de déplacer l’emplacement de votre propriété run = "..." dans votre fichier .replit. Le diff suivant montre comment fournir la commande via les args de [run], ainsi que la variable NAME fournie dans [run.env] :
-run = ["bash", "-c", "echo \"Hello, $NAME!\""]

 modules = ["nodejs-20"]

 hidden = [".pythonlibs"]

+# Nous devons déplacer notre nouveau [run] après toutes les
+# propriétés de premier niveau qui ne commencent pas par `[` !
+[run]
+args = ["bash", "-c", "echo \"Hello, $NAME!\""]
+
+[run.env]
+NAME="Replit"

 [nix]
 channel = "stable-23_11"

Interactivité

Des programmes interactifs peuvent également être lancés via le bouton Run, offrant un moyen de distinguer votre environnement de développement du terminal où votre programme s’exécute. Considérez le script de comptage suivant : Exemple
[run]
args = ["bash", "-c", """
count=0
while read -p "$PROMPT" -r next && [ -n "$next" ]; do
    count=$((count+next))
done
echo "The numbers you entered sum to $count!"
"""]

[run.env]
PROMPT = "Next number ([Enter] to end): "

Options de configuration avancées

Explorez les options de configuration détaillées disponibles pour votre application Replit. Vous pouvez personnaliser votre environnement de développement, gérer les commandes d’exécution, intégrer des services de langage et gérer les dépendances.
ConfigurationCléValeur/ExempleDescription
onBootonBootonBoot = "npm install"Commande exécutée au démarrage de l’application Replit.
compilecompile(Aucun exemple par défaut)Commande exécutée avant la commande run, utilisée dans les langages compilés comme C++.
languagelanguagelanguage = "javascript"Spécifie le langage lors d’un import GitHub ou de la création d’une application Replit.
entrypointentrypointentrypoint = "index.js"Fichier principal à exécuter et afficher à l’ouverture de l’éditeur.
hiddenhiddenhidden = [".config", "package-lock.json"]Fichiers ou dossiers à masquer par défaut dans l’arborescence de fichiers latérale.
audioaudioaudio = trueActive l’audio système lorsque la valeur est true.

Remarques sur l’audio système

Lors de la définition de audio = true dans votre fichier .replit, vous devrez peut-être exécuter kill 1 dans un shell pour forcer la prise en compte du nouveau paramètre. Lors de l’exécution d’une application graphique, vous verrez une paire d’écouteurs avec une case à cocher en bas à droite du panneau Output. En raison des restrictions du navigateur, cela devra être activé à chaque actualisation.
# Assurez-vous que cela se trouve en haut de votre fichier `.replit`, en dehors de toute section entre crochets `[`
audio = true

Configuration du gestionnaire de packages

ConfigurationCléValeur/ExempleDescription
packagerlanguagepackager.language = "python3"Langage utilisé pour les opérations de packages.
packager featuresguessImportspackager.features.guessImports = trueDevine automatiquement les packages à installer avant l’exécution de l’application Replit.
packager featurespackageSearchpackager.features.packageSearch = trueActive la prise en charge du gestionnaire de packages lorsque la valeur est true.
packager featuresenabledForHostingpackager.features.enabledForHosting = falseDéfinit si l’hébergement de l’application Replit nécessite l’exécution d’une installation de package.
packagerafterInstallafterInstall = "echo 'package installed'"Commande exécutée après l’installation d’un nouveau package via le gestionnaire de packages.
packagerignoredPathsignoredPaths = [".git"]Chemins à ignorer lors de la tentative de détection des packages.
packagerignoredPackagesignoredPackages = ["twitter", "discord"]Modules qui ne doivent jamais tenter de deviner un package lors de l’installation.

Exemple de configuration .replit pour le gestionnaire de packages

# Définir le langage pour l'application Replit
packager.language = "python3"

# Activer les fonctionnalités de gestion automatique des packages
[packager.features]
guessImports = true
packageSearch = true
enabledForHosting = false

# Commande à exécuter après chaque installation de package
packager.afterInstall = "echo 'Package installed successfully'"

# Définir les chemins et packages à ignorer par le gestionnaire de packages
packager.ignoredPaths = [".git", "node_modules"]
packager.ignoredPackages = ["twitter", "discord"]

# Paramètres de déploiement supplémentaires
[deployment]
run = ["python3", "app.py"]

Configuration du déploiement

ConfigurationCléValeur/ExempleDescription
deploymentrundeployment.run = "npm start"Commande exécutée au démarrage d’un conteneur de déploiement.
deploymentbuilddeployment.build = "npm run build"Commande exécutée avant l’exécution d’un déploiement.
deploymentignorePortsdeployment.ignorePorts = trueSi true, le succès du déploiement ne nécessite pas de vérification de port ouvert.

Exemple de configuration .replit pour le déploiement


# Spécifie le point d'entrée principal du projet
entrypoint = "app.js"

# Paramètres de configuration pour le déploiement de l'application
[deployment]
run = "npm start"
build = "npm run build"
ignorePorts = true
La configuration de l’interpréteur a été dépréciée et n’est plus disponible dans Replit. Il est recommandé d’utiliser les commandes Run pour configurer la façon dont les scripts et les applications sont exécutés dans votre environnement d’application Replit.

Configuration des ports

ConfigurationCléValeur/ExempleDescription
portslocalPortlocalPort = 3000Port que Replit lie à un port externe.
portsexternalPortexternalPort = 80Port accessible publiquement lié au localPort.

Exemple de fichier de configuration .replit pour la gestion des ports

# Configuration réseau pour exposer votre application sur des ports spécifiques
[[ports]]
localPort = 3000
externalPort = 80

Accès aux métadonnées de l’environnement de l’application Replit

Node.js

Pour accéder à toutes les variables d’environnement : console.log(process.env); Pour accéder à une variable unique (REPL_SLUG) : console.log(process.env.REPL_SLUG);

Python

Pour accéder à toutes les variables d’environnement :
import os
print(os.environ)
Pour accéder à une variable unique (REPL_SLUG) :
import os
variable = os.environ.get('REPL_SLUG')
print(variable)

Rust

Pour accéder à toutes les variables d’environnement :
use std::env;
fn main() {
    for (key, value) in env::vars() {
        println!("{}: {}", key, value);
    }
}
Pour accéder à une variable unique (REPL_SLUG) :
use std::env;
fn main() {
    let variable = env::var("REPL_SLUG").unwrap();
    println!("{}", variable);
}

Variables d’environnement

Voici les variables d’environnement accessibles depuis votre application Replit :
CléDescription
REPL_OWNERLe nom d’utilisateur du propriétaire de l’application Replit. Si votre application Replit est textuelle et n’a pas de serveur web, REPL_OWNER reflétera la valeur de l’utilisateur actuel accédant à l’application Replit
REPL_IDLa chaîne UUID unique de votre application Replit
HOMELe chemin d’accueil de votre application Replit
systemLe système d’exploitation exécuté sur votre application Replit
LANGDéfinit la langue et l’encodage des caractères pour votre application Replit, affectant la façon dont le texte est traité et affiché
REPL_IMAGEL’image docker correspondant à votre application Replit
REPL_LANGUAGELe langage de programmation configuré pour votre application Replit, utilisé pour déterminer l’environnement d’exécution et les outils
REPL_PUBKEYSUn objet JSON stringifié contenant différentes clés API publiques
REPL_SLUGUne version simplifiée et lisible par machine du nom de l’application Replit, adaptée à une utilisation dans les URLs et les noms de fichiers
PRYBAR_FILELe fichier principal/point d’entrée de votre application Replit
REPLIT_DEV_DOMAINFournit l’URL replit.dev de votre application Replit dans l’Éditeur de projet. Notez que cette variable d’environnement n’est pas disponible dans les déploiements