https://github.com/agencyenterprise/px-cli

🪄 Package manager eXecutor for JavaScript projects
https://github.com/agencyenterprise/px-cli

javascript nodejs npm pnpm typescript yarn

Last synced: 3 months ago
JSON representation

🪄 Package manager eXecutor for JavaScript projects

• Host: GitHub
• URL: https://github.com/agencyenterprise/px-cli
• Owner: agencyenterprise
• License: mit
• Created: 2024-04-28T18:50:00.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-06-03T13:03:28.000Z (7 months ago)
• Last Synced: 2024-09-30T16:30:54.022Z (3 months ago)
• Topics: javascript, nodejs, npm, pnpm, typescript, yarn
• Language: JavaScript
• Homepage: https://pxcli.com/
• Size: 83 KB
• Stars: 49
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# px

[![npm version](https://img.shields.io/npm/v/%40ae-studio%2Fpx)](https://www.npmjs.com/package/@ae-studio/px)

[![npm license](https://img.shields.io/npm/l/%40ae-studio%2Fpx)](./LICENSE)

[![monthly downloads](https://img.shields.io/npm/dm/%40ae-studio%2Fpx)](https://www.npmjs.com/package/@ae-studio/px)

**px** is a CLI tool used to run commands across different JavaScript package managers.

With **px**, you no longer need to switch between package managers when working on different projects. It detects the project's package manager and forwards the command for you. The command is not changed, just forwarded.

## Features

- Execute the same set of commands without needing to switch package managers

- Automatically installs and uninstalls **TypeScript declaration packages** with their corresponding npm packages

- For npm, **px** automatically adds the `run` prefix for npm scripts (e.g. `px dev` results in `npm run dev`)

- Compatible with **npm, pnpm, yarn, and bun**

## Install

Before installing **px**, ensure you have **Node.js >= 16** installed on your machine.

```sh

npm install -g @ae-studio/px

```

## Usage

To use **px**, simply replace your package manager command with `px` followed by the usual arguments you would pass. For example:

```sh

px install       # Installs dependencies

px dev           # Runs the 'dev' script, automatically adding 'run' for npm

px test          # Executes the 'test' script

px build         # Builds the project

```

**px** will detect the package manager your project is using and execute the command as if you had used the package manager's native CLI.

## Automatic TypeScript Declarations

**px** improves the experience of working in TypeScript projects by making it easier to manage TypeScript declaration packages. When you install or uninstall npm packages in a TypeScript project, **px** will:

- **On install**: Automatically search for and install the corresponding TypeScript declaration packages (`@types/*`) if they exist.

- **On uninstall**: Check for any installed declaration packages associated with the npm packages being removed and uninstall them as well.

This feature saves time and ensures your TypeScript types stay in sync with your installed packages, all without the need for manual intervention.

## License

This tool is open-source and available under the MIT License. See the [LICENSE](./LICENSE) file for details.

---

Built with 🧡 by [AE Studio](https://ae.studio/join-us?utm_source=sds&utm_medium=referral&utm_campaign=px-cli&utm_content=footer&utm_term=3ff5251a-e107-4d47-bfb8-b2962debd252)