mkproj est un petit utilitaire Bash pour créer rapidement un projet avec un dossier, initialiser un dépôt Git, et préparer l’environnement de travail sur Linux.
Warning
Pour que ce script fonctionne il vous faudra avoir installé et configuré GitHub CLI (gh)
- Clonez le repo :
git clone https://github.com/Dymbor/mkproj.git- Configuration minimale
Ouvrez le fichier ~/.bashrc avec un éditeur de texte :
nano ~/.bashrcAjoutez mkproj à votre fichier ~/.bashrc (ou ~/.zshrc) :
source "/chemin/vers/mkproj/mkproj.sh"- Rechargez votre configuration :
source ~/.bashrcLe répertoire dans lequel les projets sont créés est contrôlé par la variable d'environnement MKPROJ_DIR (par défaut, si elle n'est pas définie, les projets seront créés dans ~/Documents/Github/).
Pour le modifier :
# Dans ~/.zshrc ou ~/.bashrc avant de sourcer mkproj.sh
export MKPROJ_DIR="$HOME/mes-projets"mkproj nom_du_projet [options]Exemples :
mkproj demo
mkproj demo --gitignore=Python
mkproj demo --gitignore=C -cSi aucune option n'est donnée, la commande :
- Crée le répertoire
$MKPROJ_DIR/nom_du_projet - Initialise un dépôt Git
- Crée un
README.md - Effectue le commit initial
- Crée un dépôt privé sur GitHub et push le projet
| Option | Description |
|---|---|
--gitignore=<lang> |
Récupère un .gitignore depuis GitHub pour le langage donné (ex: Python, C,...) |
-c |
Crée une arborescence pour un projet C (src/, header/, main.c) |
-h, --help |
Affiche la documentation |
Templates gitignore disponibles :
gh api /gitignore/templates
- Ajouter d'autres templates (Node.js, React…)
- Rendre le projet installable automatiquement
- Ajouter des options pour configurer le repo (public/privé)
Les contributions sont les bienvenues ! N'hésitez pas à ouvrir une issue ou une pull request.
Ce projet est distribué sous licence MIT.
Vous êtes libre de l'utiliser, le modifier et le distribuer.
Voir le fichier LICENSE pour plus d'informations.