https://github.com/simon-he95/pi
smart terminal tool
https://github.com/simon-he95/pi
ccommand fuzzy-search-scripts ni ora pi
Last synced: 4 months ago
JSON representation
smart terminal tool
- Host: GitHub
- URL: https://github.com/simon-he95/pi
- Owner: Simon-He95
- License: mit
- Created: 2022-11-09T17:37:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-03T15:33:41.000Z (over 1 year ago)
- Last Synced: 2025-03-10T15:53:26.908Z (over 1 year ago)
- Topics: ccommand, fuzzy-search-scripts, ni, ora, pi
- Language: TypeScript
- Homepage:
- Size: 42.7 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: license
Awesome Lists containing this project
README
English | 简体中文
## 📖 Table of Contents
- [Introduction](#-pi)
- [Features](#-smart-package-manager)
- [Examples](#-examples)
- [Language Settings](#-language)
- [Installation](#-installation)
- [Usage](#-usage)
- [Supported Features](#-features)
- [Special Features](#-feature)
- [Custom Configuration](#-custom-configuration)
- [Dependencies](#-dependencies)
- [License](#license)
## 🍭 PI
PI is an intelligent package manager with beautiful custom loading styles, providing a better visual experience when installing dependencies. It can intelligently identify project environments, fuzzy match commands, and find deep-nested instructions, greatly improving development efficiency.
## 🚀 Smart Package Manager
PI supports package management for multiple environments:
- ✅ **Go**: Supports dependency installation, uninstallation, execution, and packaging with go mod
- ✅ **Rust**: Supports dependency installation, uninstallation, execution, and packaging with Cargo
- ✅ **Node.js**: Supports dependency installation, uninstallation, and execution with npm, pnpm, and yarn
- ✅ **Python**: Supports Python file execution
- ✅ **Monorepo**: Automatically identifies and handles differences between yarn and pnpm workspaces, fixing monorepo installation issues
## 📷 Examples
### pi - Install Dependencies
### pil - Install the latest dependencies
### pui - Uninstall Dependencies
### pci - Clear Cache
### prun - Run Commands
### pfind - Find Commands
### Other Features
## 📱 Language
```bash
# Set environment variables in your bash or zsh configuration file
# Chinese
export PI_Lang=zh
# English
export PI_Lang=en
```
## :gear: Install
```
npm i -g @simon_he/pi
```
## :open_hands: Usage
```
# According to the environment of the current directory to analyze which package manager to use，go、rust、pnpm、yarn、npm
# Install dependencies
pi xxx
# Uninstall dependencies
pui xxx
# Execute command
prun
# Execute scripts in workspace
# Execute index.js | index.ts in js | ts files or directories
# Execute main.go in go files or directories
# Execute main.rs in rust files or directories
# Execute main.py in python files or directories
pfind
# Initialization
pinit
# build - for cargo, go
pbuild
# pci
```
## Shell Integration (prun)
```
# zsh
eval "$(prun --init zsh)"
# bash
eval "$(prun --init bash)"
# fish
eval (prun --init fish)
```
> Note: This lets the command selected by prun be available immediately in your shell history (press ↑ to recall).
Auto integration (built-in):
- In interactive shells, the first `prun` run will append the right line to your shell rc (zsh: `~/.zshrc`, bash: `~/.bashrc`, fish: `~/.config/fish/config.fish`).
- Disable with `PI_NO_AUTO_INIT=1` (or set `PI_AUTO_INIT=0`).
- Open a new terminal (or source the rc file) after the first run.
Make it persistent:
```
# zsh
echo 'eval "$(prun --init zsh)"' >> ~/.zshrc
# bash
echo 'eval "$(prun --init bash)"' >> ~/.bashrc
# fish
echo 'prun --init fish | source' >> ~/.config/fish/config.fish
```
Reload your shell config (or open a new terminal) after adding the line.
## Power
The current environment is npm | yarn | pnpm, and it supports passing some args --silent
- prun dev The dev command in the current package.json
- prun If no command is specified, provide all scripts command options under the current package
- prun playground, provide all scripts command options under the current package
The current environment is go
- prun message, it will find message.go first, if not found, it will find message/main.go to execute
The current environment is rust
- prun executable cargo run
workspace of pnpm ｜ yarn
- pfind Select the package under the current workspace, and then select the corresponding command
## :monocle_face: Feature
```
<-- Go -->
## input folder and executor command
prun # default executor main.go
prun table # if table.go exists, executor table.go else executor table/main.go. and table can under any folder. For example, examples/table/main.go will also be found and executed
<-- Go -->
```
## :bulb: Custom configuration
You can configure the loading style in .zshrc, as follows：
```
export PI_COLOR=red # loadingstyle color
export PI_SPINNER=star # loadingstyle
export PI_DEFAULT=pnpm # If the current project does not set the installed package manager, you can set the default installation here
```
- 70+ types of styles, from [cli-spinners](https://jsfiddle.net/sindresorhus/2eLtsbey/embedded/result/)，You can choose to fill in the name in PI_SPINNER.
- Color options: 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray', Fill in PI_COLOR.
## :battery: Dependency
- [ora](https://github.com/sindresorhus/ora)
- [ccommand](https://github.com/Simon-He95/ccommand)
- [cargo](https://github.com/rust-lang/cargo)
## License
[MIT](./LICENSE) License © 2022 [Simon He](https://github.com/Simon-He95)
