Skip to content

readme #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
flowernotfound merged 1 commit into from
Aug 31, 2025
Merged

readme #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,30 @@ envui is a CLI tool that displays environment variables in a clean, readable tab
## Installation

```bash
git clone https://github.com/flowernotfound/envui.git
cd envui
pnpm install
pnpm build
npm install -g envui
```

## Usage

```bash
# Display all environment variables
./dist/cli.js
envui

# Prefix filtering (case-insensitive)
./dist/cli.js VITE_
./dist/cli.js NODE_
envui VITE_
envui NODE_

# Filter by partial match (case-insensitive)
./dist/cli.js --filter API
./dist/cli.js -f API
./dist/cli.js --filter database
./dist/cli.js -f database
envui --filter API
envui -f API
envui --filter database
envui -f database

# Display help
./dist/cli.js --help
envui --help

# Show version
./dist/cli.js --version
envui --version
```

## Development
Expand Down