Skip to content

shuru-project/shuru

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

174 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Shuru Logo

Shuru

A task runner and version manager for Node.js, written in Rust! Shuru simplifies your development workflow by automating tasks and managing language versions.

Version License CI Status Contributors Stars Forks Open Issues Hacktoberfest

Join us in Hacktoberfest and contribute to open source!

πŸ“š Table of Contents

🌟 Introduction

Shuru enhances productivity by offering:

  • πŸ”§ Task Automation: Define and run tasks effortlessly.
  • 🌐 Version Management: Built-in Node.js version management.
  • πŸ’» Shell Completions: Enjoy auto-completion in Bash, Zsh, and Fish.

πŸš€ Installation

Linux and macOS

To install the shuru CLI, run:

sh -c "$(curl -fsSL https://shuru.run/install.sh)"

πŸ“š Usage

  1. Create a shuru.toml File: Define tasks and versions in the file at the project root.

    Example Configuration

    [versions]
    node = "v16.14.0"
    
    [tasks.setup]
    command = "npm install"
    
    [tasks.dev]
    command = "npm run dev"
  2. Run Tasks: Execute defined tasks using:

    shuru <COMMAND>

    Example:

    shuru setup

πŸ› οΈ Detailed Examples

Node.js Project

  1. Set up a new project and create shuru.toml as above.

  2. Install dependencies:

    shuru setup
  3. Start development:

    shuru dev

🀝 Community

Join our community for support and discussions:

Discord

πŸ“„ License

This project is licensed under the MIT License. See the LICENSE file for details.

πŸ€— Contributing

We welcome contributions! Please check our Contributing Guidelines for more information on how to get involved.

About

An AI-powered task runner and version manager for Node.js, written in Rust!

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Sponsor this project

Packages

 
 
 

Contributors