Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abroudoux/pm

🗂️ Bash Utility to Manage Commands Inside Projects
https://github.com/abroudoux/pm

bash bash-script bash-utils package-manager package-manager-tool utils-scripts

Last synced: about 1 month ago
JSON representation

🗂️ Bash Utility to Manage Commands Inside Projects

Awesome Lists containing this project

README

        

# pm

Bash Utility to Manage Commands Inside Projects

## 💻 ・ Usage

`pm` allows you to easily run and manage commands on your project, according to your file reference.

```bash
# Will move you to the root of your project, then return you to your current working directory
pm npm install express
```

You can also return at the root of the project by simply use `pm`.

```bash
# Will move you to the root of your project, at the same level as your reference file
pm
```

Your previous working directory is saved, so you can use `pm -` to go back to it.

```bash
# Will move you back to your previous working directory
pm -
```

Use the `--config` flag to configure your file reference.

> By default, the value is `package.json`.

```bash
# If you're working on a Cargo-based project
pm --config cargo.lock
```

## 🧑‍🤝‍🧑 ・ Contributing

To contribute, fork the repository and open a pull request with the details of your changes.

Create a branch with a [conventionnal name](https://tilburgsciencehub.com/building-blocks/collaborate-and-share-your-work/use-github/naming-git-branches/).

- fix: `bugfix/the-bug-fixed`
- features: `feature/the-amazing-feature`
- test: `test/the-famous-test`
- hotfix `hotfix/oh-my-god-bro`
- wip `wip/the-work-name-in-progress`

## 📑 ・ License

This project is under MIT license. For more information, please see the file [LICENSE](./LICENSE).