RPJ (roc-project)

A simple project management tool because I have a ton of folders of code and need a way to open them fast. This is the rust port of my RProj tool made in Python.

CURRENTLY IN AN ALPHA STATE - MISSING FEATURES

Features

• Keep track of your projects
• Open projects quickly in VSC or file explorer - just type the name
• Open a terminal for your project fast (todo)
• Run code for your projects easily

Installation

Prerequisites:

• Rust
• Cargo

With cargo

1. Install with cargo

   cargo install rpj
   

With cli (not recommended)

Auto-PATHing only works on Windows at the moment

1. Clone the project

   git clone https://github.com/jadenlabs/rpj
   

2. Run the install command (only works on Windows for now)

   cargo run -- install
   

Usage

Commands:

-  add      | Add an existing project
-  new      | Create a new project
-  export   | Export a project to a file
-  list     | List all projects
-  get      | Get a project by name
-  code     | Open a project in VS Code
-  run      | Run a project using the run_cmd field
-  update   | Update an existing project
-  remove   | Delete an existing project
-  explore  | Open project in file explorer
-  path     | Get the path of a project
-  terminal | Open your project in the terminal
-  help     | Display RPJ usage instructions

Contributing

Please open an issue for any feature requests or bug reports. Alternatively, message @roc.py on Discord.

If there is an open issue that you'd like to work on, feel free to fork the repo and make a PR when you're done.

Guidelines:

• Use the Conventional Commits commit style.
• Do not push code that you do not have the rights to.
• Do not push code that has primarily been generated by a llm, using it to debug is fine.
• Make sure to satisfy clippy before pushing a PR (run cargo clippy --verbose -- -D warnings)

License

This project is licensed under the MIT License - pretty much meaning, you can do almost whatever you want as long as you keep the original copyright in the code. This software doesn't come with a warrenty for anything bad happening.

A better explaination: here