Skip to content

fedeegmz/nester

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nester CLI

Nester is a command-line interface (CLI) tool written in Rust that helps generate basic structures for **Kotlin/Ktor ** projects using Koin as a dependency injector.

🚀 Installation

🔧 Install Using Script

   chmod +x ./scripts/install.sh
   ./scripts/install.sh

This script:

  1. Compiles the project in release mode.
  2. Checks if a previous version exists in /usr/local/bin/.
    • If found, it creates a backup before replacing it.
  3. Moves the new binary to /usr/local/bin/.

🏹 Arch Linux (AUR)

  yay -S nester

📁 Precompiled Binary

   wget https://github.com/fedeegmz/nester/releases/download/v0.1.0/nester
   chmod +x nester
   sudo mv nester /usr/local/bin/

🛠 Usage

✅ Generate a New File

   nester generate --path <file_path> --name  --pkg

Parameters:

  • --path: Path and name of the file to generate (required)
  • --name: Name for the generated content (optional)
  • --pkg: Package name for the generated content (optional)

Example:

  nester generate --path Injection.kt --name user --pkg com.example

❌ Uninstallation

🔥 Remove Nester

To uninstall nester, run:

   chmod +x ./scripts/uninstall.sh
   ./scripts/uninstall.sh

This script:

  1. Checks if nester exists in /usr/local/bin/.
  2. Removes the binary if found.

🧹 Clean Backup Files

If you want to remove all backup files created during installation, run:

   chmod +x ./scripts/clean_backups.sh
   ./scripts/clean_backups.sh

This script:

  1. Finds all backup files matching /usr/local/bin/nester.backup_*.
  2. Deletes them permanently.

📋 Requirements

  • Rust 1.70+

📜 License

This project is licensed under the GPL-3.0 License. See the full license here.

About

CLI tool that facilitates generating basic files from templates.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors