Skip to content

vimichael/spm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SPM | Simple Project Manager

My personal terminal-based project manager.

Why?

I'm a person that likes to start projects every other day. I have lists and lists of ideas that don't make it off the ground. As a result, it's hard to keep track of what I am currently focused on. I lose where I put a project, or I forget about it all together. SPM was built to fix that. Each project is tracked in the terminal, where I am most comfortable. That means I don't need to open File Explorer to look through pages of nonsense to find what I want.

Features

Feature Status
add
remove
list
copypath
contains
help
lookup
init
load

For more information, run spm --help to get detailed instructions for each command

Installation

  1. Clone the repository:
git clone https://github.com/m1chaelwilliams/spm.git
  1. Add it to your PATH environment variables
  2. Spin up the database:
spm spinup

Example Usage

All of the commands are intuitive with useful shortcuts to make things faster. For example, adding a project can look like:

# option 1
spm add -name="example" -path="C:\example\path"
# option 2
spm add . -name="example"
# option 3 (must be in the directory to start)
spm add .

There are also options for loading projects from JSON:

# create a skeleton json project file in cwd
spm init
# load that json file into the database
spm load

Here's what the JSON file could look like:

{
  "name": "",
  "path": "",
  "metadata": {}
}

Copyright

This repository is licensed under MIT.

Feature Request

This is my own personal project manager tool. So, if a feature is to be added, I must like it. Please feel free to request them though!

About

A simple terminal project manager.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors