Project Manager

A simple CLI to manage your projects locally

Report Bug . Request Feature

Note : This is a alpha release. There may be breaking changes. I am not responsible for any harm caused to your system. Please use it at your own risk

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Installation
• Usage
• Contributing
• License
• Authors
• Acknowledgements

About The Project

I was tired of flying around in my terminal to navigate from one project to another. I used to use neovim's startify but that wasn't cutting it for me. As I had just started learning rust, I thought to build what I needed.

This is pm, a simple project manager of sorts written in rust. pm helps you open your frequently visited projects in one line. This is implemented for linux for now, but I will try to make it to work with windows too.

Built With

pm is built with rust, the most beloved language, and it's not hard to see why. As a complete newbie to rust, it was pretty easy to get started and the community was also very helpful.

Getting Started

To get started with pm, you can either download the binary from the downloads page or you can build it yourself.

Installation

1. Download the latest release from the releases page.

2. Go to the folder you downloaded too. For example, it was downloaded to the Downloads folder.

cd ~/Downloads

3. Set the permissions for the binary to be executable

chmod +x ./pm

4. Copy the binary to the bin folder to be executable from anywhere

sudo cp pm /usr/local/bin/

Usage

• Initialize pm
  
  First we need to initialize pm. This will create all the required folders and files locally, like a json-database.

  pm init

• Add a new project
  
  We can add a new project by specifying a name and the editor we want to use. For now there are 2 options for the editor, neovim & 'VScode'. Run pm help add to see more.

  To add a new project

  pm add -n "project name" -e vscode ~/Work/my-project

• List projects
  
  To list all projects you have

  pm list

• Open a project
  
  You can open a project you added, in your selected editor, by specifying the project name

  pm open "project name"

• Help
  
  To get help and see the list of commands

  pm help

  To get help with a specific command

  pm help <Command-Name>
  
  pm help open

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• CinematicCow - Software Engineer - CinematicCow