https://github.com/vimichael/spm
A simple terminal project manager.
https://github.com/vimichael/spm
Last synced: 3 months ago
JSON representation
A simple terminal project manager.
- Host: GitHub
- URL: https://github.com/vimichael/spm
- Owner: vimichael
- License: mit
- Created: 2024-07-11T21:43:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-12T02:06:01.000Z (over 1 year ago)
- Last Synced: 2025-09-08T20:35:08.430Z (5 months ago)
- Language: Go
- Size: 17.3 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```shell
git clone https://github.com/m1chaelwilliams/spm.git
```
2. Add it to your **PATH** environment variables
3. Spin up the database:
```shell
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:
```shell
# 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**:
```shell
# 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:
```json
{
"name": "",
"path": "",
"metadata": {}
}
```
# Copyright
This repository is licensed under [MIT](./LICENSE).
# 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!