UNPKG

open-project-cli

Version:

Very opinionated CLI tool that opens project folders in VSCode.

90 lines (48 loc) 3.69 kB
# open-project-cli <a href="https://raw.githubusercontent.com/jaid/open-project-cli/master/license.txt"><img src="https://img.shields.io/github/license/jaid/open-project-cli?style=flat-square" alt="License"/></a> <a href="https://github.com/sponsors/jaid"><img src="https://img.shields.io/badge/<3-Sponsor-FF45F1?style=flat-square" alt="Sponsor open-project-cli"/></a> <a href="https://actions-badge.atrox.dev/jaid/open-project-cli/goto"><img src="https://img.shields.io/endpoint.svg?style=flat-square&url=https%3A%2F%2Factions-badge.atrox.dev%2Fjaid%2Fopen-project-cli%2Fbadge" alt="Build status"/></a> <a href="https://github.com/jaid/open-project-cli/commits"><img src="https://img.shields.io/github/commits-since/jaid/open-project-cli/v5.0.0?style=flat-square&logo=github" alt="Commits since v5.0.0"/></a> <a href="https://github.com/jaid/open-project-cli/commits"><img src="https://img.shields.io/github/last-commit/jaid/open-project-cli?style=flat-square&logo=github" alt="Last commit"/></a> <a href="https://github.com/jaid/open-project-cli/issues"><img src="https://img.shields.io/github/issues/jaid/open-project-cli?style=flat-square&logo=github" alt="Issues"/></a> <a href="https://npmjs.com/package/open-project-cli"><img src="https://img.shields.io/npm/v/open-project-cli?style=flat-square&logo=npm&label=latest%20version" alt="Latest version on npm"/></a> <a href="https://github.com/jaid/open-project-cli/network/dependents"><img src="https://img.shields.io/librariesio/dependents/npm/open-project-cli?style=flat-square&logo=npm" alt="Dependents"/></a> <a href="https://npmjs.com/package/open-project-cli"><img src="https://img.shields.io/npm/dm/open-project-cli?style=flat-square&logo=npm" alt="Downloads"/></a> **Very opinionated CLI tool that opens project folders in VSCode.** #### Opinionated This project is tailored to my personal needs and workflows and therefore highly opinionated. Feel free to use it or get inspired by it, but please do not get frustrated if you come across weird features or have difficulties integrating it in your own ecosystem. ## Installation <a href="https://npmjs.com/package/open-project-cli"><img src="https://img.shields.io/badge/npm-open--project--cli-C23039?style=flat-square&logo=npm" alt="open-project-cli on npm"/></a> ```bash npm install --global open-project-cli@^5.0.0 ``` <a href="https://yarnpkg.com/package/open-project-cli"><img src="https://img.shields.io/badge/Yarn-open--project--cli-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="open-project-cli on Yarn"/></a> ```bash yarn global add open-project-cli@^5.0.0 ``` <a href="https://github.com/jaid/open-project-cli/packages"><img src="https://img.shields.io/badge/GitHub Packages-@jaid/open--project--cli-24282e?style=flat-square&logo=github" alt="@jaid/open-project-cli on GitHub Packages"/></a> (if [configured properly](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages)) ```bash npm install --global @jaid/open-project-cli@^5.0.0 ``` ## CLI Usage After installing package `open-project-cli` globally, you can use its command line interface. ```bash open-project-cli epoch-seconds ``` For usage instructions: ```bash open-project-cli --help ``` ## Development Setting up: ```bash git clone git@github.com:jaid/open-project-cli.git cd open-project-cli npm install ``` Testing: ```bash npm run test:dev ``` Testing in production environment: ```bash npm run test ``` ## License [MIT License](https://raw.githubusercontent.com/jaid/open-project-cli/master/license.txt) Copyright © 2020, Jaid \<jaid.jsx@gmail.com> (https://github.com/jaid)