README
¶
_ __ _ __ ___
| '_ \| '_ ` _ \
| |_) | | | | | |
| .__/|_| |_| |_|
| |
|_|
pm is a go cli allowing users to rapidly create new projects. It integrate with tmux to allow for a seemless navigation.
Prerequisites
- go 1.21 or higher
- tmux
- git
🧰 Installation
go install github.com/alexis-moins/pm@latest
🌱 Quick Start
After installing, you can follow these steps to quickly see how it works:
# Add a new space (a 'default' space is setup by pm for you)
pm space add personal
# You can then create new projects in this space
pm new portal --space personal
# Opening the project is even simpler
pm open portal --space personal
# You can also specify a short format
pm open personal/portal
# You can even clone github repositories
pm clone alexis-moins/portfolio --space work
🚦 Usage
$ pm
Project manager built on top of tmux
Usage:
pm [command]
Project Commands:
clone Clone a remote git repository
list List projects
new Create a new empty project
open Open a project in a tmux session
Additional Commands:
completion Generate the autocompletion script for the specified shell
dir Show the path to the directory managed by pm
help Help about any command
space Create, delete and list spaces
template Create, delete and list templates
Flags:
-h, --help help for pm
-v, --version version for pm
Documentation
¶
Overview ¶
Copyright © 2023 Alexis Moins <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source Files
Directories